# Classifications

Classification hierarchy management

## POST /api/v1/classifications/create

>

```json
{"openapi":"3.1.0","info":{"title":"Rules Service API","version":"1.0.0"},"tags":[{"name":"Classifications","description":"Classification hierarchy management"}],"servers":[{"url":"https://rules.app.gomboc.ai/"}],"paths":{"/api/v1/classifications/create":{"post":{"operationId":"PostApiV1ClassificationsCreate","tags":["Classifications"],"requestBody":{"description":"POST /api/v1/classifications/create Request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostApiV1ClassificationsCreateRequestBody"}}},"required":true},"responses":{"200":{"description":"POST /api/v1/classifications/create Positive response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostApiV1ClassificationsCreatePositiveResponse"}}}},"400":{"description":"POST /api/v1/classifications/create Negative response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostApiV1ClassificationsCreateNegativeResponse"}}}}}}}},"components":{"schemas":{"PostApiV1ClassificationsCreateRequestBody":{"type":"object","properties":{"name":{"type":"string"},"parent":{"type":"string"},"shortName":{"type":"string"},"description":{"type":"string"},"annotations":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["name"]},"PostApiV1ClassificationsCreatePositiveResponse":{"type":"object","properties":{"status":{"type":"string","const":"success"},"data":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"},"name":{"type":"string"},"parent":{"type":["string","null"]},"shortName":{"type":["string","null"]},"description":{"type":["string","null"]},"annotations":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"},"createdAt":{},"updatedAt":{},"parentPath":{"type":"array","items":{"type":"string"}},"children":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["accountId","name","parent","shortName","description","id","createdAt","updatedAt"],"additionalProperties":false}},"required":["status","data"],"additionalProperties":false},"PostApiV1ClassificationsCreateNegativeResponse":{"type":"object","properties":{"status":{"type":"string","const":"error"},"error":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"required":["status","error"],"additionalProperties":false}}}}
```

## GET /api/v1/classifications/get

>

```json
{"openapi":"3.1.0","info":{"title":"Rules Service API","version":"1.0.0"},"tags":[{"name":"Classifications","description":"Classification hierarchy management"}],"servers":[{"url":"https://rules.app.gomboc.ai/"}],"paths":{"/api/v1/classifications/get":{"get":{"operationId":"GetApiV1ClassificationsGet","tags":["Classifications"],"parameters":[{"name":"name","in":"query","required":true,"description":"GET /api/v1/classifications/get Parameter","schema":{"$ref":"#/components/schemas/GetApiV1ClassificationsGetParameterName"}},{"name":"parents","in":"query","required":false,"description":"GET /api/v1/classifications/get Parameter","schema":{"$ref":"#/components/schemas/GetApiV1ClassificationsGetParameterParents"}},{"name":"children","in":"query","required":false,"description":"GET /api/v1/classifications/get Parameter","schema":{"$ref":"#/components/schemas/GetApiV1ClassificationsGetParameterChildren"}},{"name":"expandChildren","in":"query","required":false,"description":"GET /api/v1/classifications/get Parameter","schema":{"$ref":"#/components/schemas/GetApiV1ClassificationsGetParameterExpandChildren"}}],"responses":{"200":{"description":"GET /api/v1/classifications/get Positive response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApiV1ClassificationsGetPositiveResponse"}}}},"400":{"description":"GET /api/v1/classifications/get Negative response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApiV1ClassificationsGetNegativeResponse"}}}}}}}},"components":{"schemas":{"GetApiV1ClassificationsGetParameterName":{"type":"string"},"GetApiV1ClassificationsGetParameterParents":{"default":0,"type":"number"},"GetApiV1ClassificationsGetParameterChildren":{"default":0,"type":"number"},"GetApiV1ClassificationsGetParameterExpandChildren":{"default":false,"type":"boolean"},"GetApiV1ClassificationsGetPositiveResponse":{"type":"object","properties":{"status":{"type":"string","const":"success"},"data":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"},"name":{"type":"string"},"parent":{"type":["string","null"]},"shortName":{"type":["string","null"]},"description":{"type":["string","null"]},"annotations":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"},"createdAt":{},"updatedAt":{},"parentPath":{"type":"array","items":{"type":"string"}},"children":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["accountId","name","parent","shortName","description","id","createdAt","updatedAt"],"additionalProperties":false}},"required":["status","data"],"additionalProperties":false},"GetApiV1ClassificationsGetNegativeResponse":{"type":"object","properties":{"status":{"type":"string","const":"error"},"error":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"required":["status","error"],"additionalProperties":false}}}}
```

## PUT /api/v1/classifications/update

>

```json
{"openapi":"3.1.0","info":{"title":"Rules Service API","version":"1.0.0"},"tags":[{"name":"Classifications","description":"Classification hierarchy management"}],"servers":[{"url":"https://rules.app.gomboc.ai/"}],"paths":{"/api/v1/classifications/update":{"put":{"operationId":"PutApiV1ClassificationsUpdate","tags":["Classifications"],"requestBody":{"description":"PUT /api/v1/classifications/update Request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutApiV1ClassificationsUpdateRequestBody"}}},"required":true},"responses":{"200":{"description":"PUT /api/v1/classifications/update Positive response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutApiV1ClassificationsUpdatePositiveResponse"}}}},"400":{"description":"PUT /api/v1/classifications/update Negative response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutApiV1ClassificationsUpdateNegativeResponse"}}}}}}}},"components":{"schemas":{"PutApiV1ClassificationsUpdateRequestBody":{"type":"object","properties":{"name":{"type":"string"},"parent":{"type":"string"},"shortName":{"type":"string"},"description":{"type":"string"},"annotations":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["name"]},"PutApiV1ClassificationsUpdatePositiveResponse":{"type":"object","properties":{"status":{"type":"string","const":"success"},"data":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"},"name":{"type":"string"},"parent":{"type":["string","null"]},"shortName":{"type":["string","null"]},"description":{"type":["string","null"]},"annotations":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"},"createdAt":{},"updatedAt":{},"parentPath":{"type":"array","items":{"type":"string"}},"children":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["accountId","name","parent","shortName","description","id","createdAt","updatedAt"],"additionalProperties":false}},"required":["status","data"],"additionalProperties":false},"PutApiV1ClassificationsUpdateNegativeResponse":{"type":"object","properties":{"status":{"type":"string","const":"error"},"error":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"required":["status","error"],"additionalProperties":false}}}}
```

## DELETE /api/v1/classifications/delete

>

```json
{"openapi":"3.1.0","info":{"title":"Rules Service API","version":"1.0.0"},"tags":[{"name":"Classifications","description":"Classification hierarchy management"}],"servers":[{"url":"https://rules.app.gomboc.ai/"}],"paths":{"/api/v1/classifications/delete":{"delete":{"operationId":"DeleteApiV1ClassificationsDelete","tags":["Classifications"],"parameters":[{"name":"name","in":"query","required":true,"description":"DELETE /api/v1/classifications/delete Parameter","schema":{"$ref":"#/components/schemas/DeleteApiV1ClassificationsDeleteParameterName"}}],"responses":{"200":{"description":"DELETE /api/v1/classifications/delete Positive response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteApiV1ClassificationsDeletePositiveResponse"}}}},"400":{"description":"DELETE /api/v1/classifications/delete Negative response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteApiV1ClassificationsDeleteNegativeResponse"}}}}}}}},"components":{"schemas":{"DeleteApiV1ClassificationsDeleteParameterName":{"type":"string"},"DeleteApiV1ClassificationsDeletePositiveResponse":{"type":"object","properties":{"status":{"type":"string","const":"success"},"data":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"],"additionalProperties":false}},"required":["status","data"],"additionalProperties":false},"DeleteApiV1ClassificationsDeleteNegativeResponse":{"type":"object","properties":{"status":{"type":"string","const":"error"},"error":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"required":["status","error"],"additionalProperties":false}}}}
```

## GET /api/v1/classifications/search

>

```json
{"openapi":"3.1.0","info":{"title":"Rules Service API","version":"1.0.0"},"tags":[{"name":"Classifications","description":"Classification hierarchy management"}],"servers":[{"url":"https://rules.app.gomboc.ai/"}],"paths":{"/api/v1/classifications/search":{"get":{"operationId":"GetApiV1ClassificationsSearch","tags":["Classifications"],"parameters":[{"name":"page","in":"query","required":false,"description":"GET /api/v1/classifications/search Parameter","schema":{"$ref":"#/components/schemas/GetApiV1ClassificationsSearchParameterPage"}},{"name":"perPage","in":"query","required":false,"description":"GET /api/v1/classifications/search Parameter","schema":{"$ref":"#/components/schemas/GetApiV1ClassificationsSearchParameterPerPage"}},{"name":"query","in":"query","required":false,"description":"GET /api/v1/classifications/search Parameter","schema":{"$ref":"#/components/schemas/GetApiV1ClassificationsSearchParameterQuery"}},{"name":"filters","in":"query","required":false,"description":"GET /api/v1/classifications/search Parameter","schema":{"$ref":"#/components/schemas/GetApiV1ClassificationsSearchParameterFilters"}},{"name":"filters[]","in":"query","required":false,"description":"GET /api/v1/classifications/search Parameter","schema":{"$ref":"#/components/schemas/GetApiV1ClassificationsSearchParameterFilters"}}],"responses":{"200":{"description":"GET /api/v1/classifications/search Positive response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApiV1ClassificationsSearchPositiveResponse"}}}},"400":{"description":"GET /api/v1/classifications/search Negative response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApiV1ClassificationsSearchNegativeResponse"}}}}}}}},"components":{"schemas":{"GetApiV1ClassificationsSearchParameterPage":{"default":1,"type":"number"},"GetApiV1ClassificationsSearchParameterPerPage":{"default":20,"type":"number"},"GetApiV1ClassificationsSearchParameterQuery":{"type":"string"},"GetApiV1ClassificationsSearchParameterFilters":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"GetApiV1ClassificationsSearchPositiveResponse":{"type":"object","properties":{"status":{"type":"string","const":"success"},"data":{"type":"object","properties":{"classifications":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"},"name":{"type":"string"},"parent":{"type":["string","null"]},"shortName":{"type":["string","null"]},"description":{"type":["string","null"]},"annotations":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"},"createdAt":{},"updatedAt":{},"parentPath":{"type":"array","items":{"type":"string"}},"children":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["accountId","name","parent","shortName","description","id","createdAt","updatedAt"],"additionalProperties":false}},"total":{"type":"number"},"page":{"type":"number"},"perPage":{"type":"number"}},"required":["classifications","total","page","perPage"],"additionalProperties":false}},"required":["status","data"],"additionalProperties":false},"GetApiV1ClassificationsSearchNegativeResponse":{"type":"object","properties":{"status":{"type":"string","const":"error"},"error":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"required":["status","error"],"additionalProperties":false}}}}
```