Classifications

Classification hierarchy management

post

Body

namestringRequired

parentstringOptional

shortNamestringOptional

descriptionstringOptional

Responses

200

POST /api/v1/classifications/create Positive response

application/json

statusconst: successRequired

400

POST /api/v1/classifications/create Negative response

application/json

post/api/v1/classifications/create

POST /api/v1/classifications/create HTTP/1.1
Host: rules.app.gomboc.ai
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "name": "text",
  "parent": "text",
  "shortName": "text",
  "description": "text",
  "annotations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "status": "text",
  "data": {
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "parent": null,
    "shortName": null,
    "description": null,
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": null,
    "updatedAt": null,
    "parentPath": [
      "text"
    ],
    "children": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

get

Query parameters

namestringRequired

GET /api/v1/classifications/get Parameter

parentsnumberOptional

GET /api/v1/classifications/get Parameter

Default: 0

childrennumberOptional

GET /api/v1/classifications/get Parameter

Default: 0

expandChildrenbooleanOptional

GET /api/v1/classifications/get Parameter

Default: false

Responses

200

GET /api/v1/classifications/get Positive response

application/json

statusconst: successRequired

400

GET /api/v1/classifications/get Negative response

application/json

get/api/v1/classifications/get

GET /api/v1/classifications/get?name=text HTTP/1.1
Host: rules.app.gomboc.ai
Accept: */*

{
  "status": "text",
  "data": {
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "parent": null,
    "shortName": null,
    "description": null,
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": null,
    "updatedAt": null,
    "parentPath": [
      "text"
    ],
    "children": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

head

Query parameters

namestringRequired

HEAD /api/v1/classifications/get Parameter

parentsnumberOptional

HEAD /api/v1/classifications/get Parameter

Default: 0

childrennumberOptional

HEAD /api/v1/classifications/get Parameter

Default: 0

expandChildrenbooleanOptional

HEAD /api/v1/classifications/get Parameter

Default: false

Responses

200

HEAD /api/v1/classifications/get Positive response

No content

400

HEAD /api/v1/classifications/get Negative response

head/api/v1/classifications/get

HEAD /api/v1/classifications/get?name=text HTTP/1.1
Host: rules.app.gomboc.ai
Accept: */*

No content

put

Body

namestringRequired

parentstringOptional

shortNamestringOptional

descriptionstringOptional

Responses

200

PUT /api/v1/classifications/update Positive response

application/json

statusconst: successRequired

400

PUT /api/v1/classifications/update Negative response

application/json

put/api/v1/classifications/update

PUT /api/v1/classifications/update HTTP/1.1
Host: rules.app.gomboc.ai
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "name": "text",
  "parent": "text",
  "shortName": "text",
  "description": "text",
  "annotations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "status": "text",
  "data": {
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "parent": null,
    "shortName": null,
    "description": null,
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": null,
    "updatedAt": null,
    "parentPath": [
      "text"
    ],
    "children": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

delete

Query parameters

namestringRequired

DELETE /api/v1/classifications/delete Parameter

Responses

200

DELETE /api/v1/classifications/delete Positive response

application/json

statusconst: successRequired

400

DELETE /api/v1/classifications/delete Negative response

application/json

delete/api/v1/classifications/delete

DELETE /api/v1/classifications/delete?name=text HTTP/1.1
Host: rules.app.gomboc.ai
Accept: */*

{
  "status": "text",
  "data": {
    "success": true
  }
}

get

Query parameters

pagenumberOptional

GET /api/v1/classifications/search Parameter

Default: 1

perPagenumberOptional

GET /api/v1/classifications/search Parameter

Default: 20

querystringOptional

GET /api/v1/classifications/search Parameter

filtersany ofOptional

GET /api/v1/classifications/search Parameter

stringOptional

or

string[]Optional

filters[]any ofOptional

GET /api/v1/classifications/search Parameter

stringOptional

or

string[]Optional

Responses

200

GET /api/v1/classifications/search Positive response

application/json

statusconst: successRequired

400

GET /api/v1/classifications/search Negative response

application/json

get/api/v1/classifications/search

GET /api/v1/classifications/search HTTP/1.1
Host: rules.app.gomboc.ai
Accept: */*

{
  "status": "text",
  "data": {
    "classifications": [
      {
        "accountId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "parent": null,
        "shortName": null,
        "description": null,
        "annotations": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": null,
        "updatedAt": null,
        "parentPath": [
          "text"
        ],
        "children": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "total": 1,
    "page": 1,
    "perPage": 1
  }
}

head

Query parameters

pagenumberOptional

HEAD /api/v1/classifications/search Parameter

Default: 1

perPagenumberOptional

HEAD /api/v1/classifications/search Parameter

Default: 20

querystringOptional

HEAD /api/v1/classifications/search Parameter

filtersany ofOptional

HEAD /api/v1/classifications/search Parameter

stringOptional

or

string[]Optional

filters[]any ofOptional

HEAD /api/v1/classifications/search Parameter

stringOptional

or

string[]Optional

Responses

200

HEAD /api/v1/classifications/search Positive response

No content

400

HEAD /api/v1/classifications/search Negative response

head/api/v1/classifications/search

HEAD /api/v1/classifications/search HTTP/1.1
Host: rules.app.gomboc.ai
Accept: */*

No content