Ux

Gets a list of customer ci configurations

get

This endpoint is used to fetch all the customer ci configurations in the current organization

Authorizations

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

application/json

object[]Optional

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

get

HTTPcURLJavaScriptPython

GET /ux/common/cmdb/item-classification/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "text",
    "customer_id": "text",
    "customer_entity_id": "text",
    "template_id": "text",
    "template_name": "text",
    "cmdb_class": 1,
    "creation_time": "2025-04-18T23:21:00.255Z",
    "last_update_time": "2025-04-18T23:21:00.255Z",
    "is_deleted": true,
    "is_preconfigured": true
  }
]

Creates a new ci classification

post

This endpoint is used to save a new ci classification for the current organization

Authorizations

Body

Other propertiesanyOptional

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/cmdb/item-classification/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "classification_name": "",
  "classification_filters": ""
}

201

No response body

No content

Gets a ci classification with the given id

get

This endpoint is used to fetch a ci classification in the current organization

Authorizations

Path parameters

idstringRequired

Responses

application/json

objectOptional

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

get

HTTPcURLJavaScriptPython

GET /ux/common/cmdb/item-classification/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "template_id": "text",
  "template_name": "text",
  "cmdb_class": 1,
  "creation_time": "2025-04-18T23:21:00.255Z",
  "last_update_time": "2025-04-18T23:21:00.255Z",
  "is_deleted": true,
  "is_preconfigured": true
}

Edits the ci classification with given id

put

This endpoint is used to edit an existing ci classification for the current organization

Authorizations

Path parameters

idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

customer_idstringRead-onlyRequired

customer_entity_idstringRead-onlyRequired

template_idstringRequired

template_namestringOptional

cmdb_classintegerOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

is_deletedbooleanOptional

is_preconfiguredbooleanOptional

Responses

application/json

objectOptional

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

put

HTTPcURLJavaScriptPython

PUT /ux/common/cmdb/item-classification/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "template_id": "text",
  "template_name": "text",
  "cmdb_class": 1,
  "creation_time": "2025-04-18T23:21:00.255Z",
  "last_update_time": "2025-04-18T23:21:00.255Z",
  "is_deleted": true,
  "is_preconfigured": true
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "template_id": "text",
  "template_name": "text",
  "cmdb_class": 1,
  "creation_time": "2025-04-18T23:21:00.255Z",
  "last_update_time": "2025-04-18T23:21:00.255Z",
  "is_deleted": true,
  "is_preconfigured": true
}

delete

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /ux/common/cmdb/item-classification/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

application/json

objectOptional

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

get

HTTPcURLJavaScriptPython

GET /ux/common/cmdb/item-classification/default-item-classifications/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "template_id": "text",
  "template_name": "text",
  "cmdb_class": 1,
  "creation_time": "2025-04-18T23:21:00.255Z",
  "last_update_time": "2025-04-18T23:21:00.255Z",
  "is_deleted": true,
  "is_preconfigured": true
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

customer_idstringRead-onlyRequired

customer_entity_idstringRead-onlyRequired

template_idstringRequired

template_namestringOptional

cmdb_classintegerOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

is_deletedbooleanOptional

is_preconfiguredbooleanOptional

Responses

application/json

objectOptional

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

post

HTTPcURLJavaScriptPython

POST /ux/common/cmdb/item-classification/delete-classification-config/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "template_id": "text",
  "template_name": "text",
  "cmdb_class": 1,
  "creation_time": "2025-04-18T23:21:00.255Z",
  "last_update_time": "2025-04-18T23:21:00.255Z",
  "is_deleted": true,
  "is_preconfigured": true
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "template_id": "text",
  "template_name": "text",
  "cmdb_class": 1,
  "creation_time": "2025-04-18T23:21:00.255Z",
  "last_update_time": "2025-04-18T23:21:00.255Z",
  "is_deleted": true,
  "is_preconfigured": true
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

customer_idstringRead-onlyRequired

customer_entity_idstringRead-onlyRequired

template_idstringRequired

template_namestringOptional

cmdb_classintegerOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

is_deletedbooleanOptional

is_preconfiguredbooleanOptional

Responses

application/json

objectOptional

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

post

HTTPcURLJavaScriptPython

POST /ux/common/cmdb/item-classification/delete-sub-classification/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "template_id": "text",
  "template_name": "text",
  "cmdb_class": 1,
  "creation_time": "2025-04-18T23:21:00.255Z",
  "last_update_time": "2025-04-18T23:21:00.255Z",
  "is_deleted": true,
  "is_preconfigured": true
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "template_id": "text",
  "template_name": "text",
  "cmdb_class": 1,
  "creation_time": "2025-04-18T23:21:00.255Z",
  "last_update_time": "2025-04-18T23:21:00.255Z",
  "is_deleted": true,
  "is_preconfigured": true
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

application/json

objectOptional

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

get

HTTPcURLJavaScriptPython

GET /ux/common/cmdb/item-classification/item-classifications-tree/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "template_id": "text",
  "template_name": "text",
  "cmdb_class": 1,
  "creation_time": "2025-04-18T23:21:00.255Z",
  "last_update_time": "2025-04-18T23:21:00.255Z",
  "is_deleted": true,
  "is_preconfigured": true
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

application/json

objectOptional

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

get

HTTPcURLJavaScriptPython

GET /ux/common/cmdb/item-classification/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "template_id": "text",
  "template_name": "text",
  "cmdb_class": 1,
  "creation_time": "2025-04-18T23:21:00.255Z",
  "last_update_time": "2025-04-18T23:21:00.255Z",
  "is_deleted": true,
  "is_preconfigured": true
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

customer_idstringRead-onlyRequired

customer_entity_idstringRead-onlyRequired

template_idstringRequired

template_namestringOptional

cmdb_classintegerOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

is_deletedbooleanOptional

is_preconfiguredbooleanOptional

Responses

application/json

objectOptional

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

post

HTTPcURLJavaScriptPython

POST /ux/common/cmdb/item-classification/pin-item-classifications/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "template_id": "text",
  "template_name": "text",
  "cmdb_class": 1,
  "creation_time": "2025-04-18T23:21:00.255Z",
  "last_update_time": "2025-04-18T23:21:00.255Z",
  "is_deleted": true,
  "is_preconfigured": true
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "template_id": "text",
  "template_name": "text",
  "cmdb_class": 1,
  "creation_time": "2025-04-18T23:21:00.255Z",
  "last_update_time": "2025-04-18T23:21:00.255Z",
  "is_deleted": true,
  "is_preconfigured": true
}

get

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/purchase_order/config/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

post

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/purchase_order/config/ HTTP/1.1
Host: 
Accept: */*

201

No response body

No content

get

Authorizations

cookieAuthbasicAuthApiKeyAuth

Path parameters

idstringRequired

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/purchase_order/config/{id}/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

put

Authorizations

cookieAuthbasicAuthApiKeyAuth

Path parameters

idstringRequired

Responses

put

HTTPcURLJavaScriptPython

PUT /ux/common/purchase_order/config/{id}/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

delete

Authorizations

cookieAuthbasicAuthApiKeyAuth

Path parameters

idstringRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /ux/common/purchase_order/config/{id}/ HTTP/1.1
Host: 
Accept: */*

204

No response body

No content

patch

Authorizations

cookieAuthbasicAuthApiKeyAuth

Path parameters

idstringRequired

Responses

patch

HTTPcURLJavaScriptPython

PATCH /ux/common/purchase_order/config/{id}/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

post

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/purchase_order/config/add-approval-config/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

post

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/purchase_order/config/add-attachment/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

post

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/purchase_order/config/add_received_assets/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

post

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/purchase_order/config/add_received_product_history/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

get

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/purchase_order/config/attachment/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

put

Authorizations

cookieAuthbasicAuthApiKeyAuth

Path parameters

idstringRequired

Responses

put

HTTPcURLJavaScriptPython

PUT /ux/common/purchase_order/config/delete-attachment/{id}/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

post

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/purchase_order/config/delete_po/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

get

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/purchase_order/config/get-approval-config/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

get

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/purchase_order/config/get_asset_category_unique_fields/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

get

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/purchase_order/config/get_invoice_file/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

get

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/purchase_order/config/get_received_product_history/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

get

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/purchase_order/config/history/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

get

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/purchase_order/config/options/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

post

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/purchase_order/config/send_po_mail/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

get

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/purchase_order/config/vendor_options/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/report/api/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

post

Adaptation of DRF ModelViewSet

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/report/api/ HTTP/1.1
Host: 
Accept: */*

201

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

cookieAuthbasicAuthApiKeyAuth

Path parameters

idstringRequired

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/report/api/{id}/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

put

Adaptation of DRF ModelViewSet

Authorizations

cookieAuthbasicAuthApiKeyAuth

Path parameters

idstringRequired

Responses

put

HTTPcURLJavaScriptPython

PUT /ux/common/report/api/{id}/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

delete

Adaptation of DRF ModelViewSet

Authorizations

cookieAuthbasicAuthApiKeyAuth

Path parameters

idstringRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /ux/common/report/api/{id}/ HTTP/1.1
Host: 
Accept: */*

204

No response body

No content

patch

Adaptation of DRF ModelViewSet

Authorizations

cookieAuthbasicAuthApiKeyAuth

Path parameters

idstringRequired

Responses

patch

HTTPcURLJavaScriptPython

PATCH /ux/common/report/api/{id}/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

post

Adaptation of DRF ModelViewSet

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/report/api/dashboard/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

post

Adaptation of DRF ModelViewSet

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/report/api/mrtg-stats-data/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

post

Adaptation of DRF ModelViewSet

Authorizations

cookieAuthbasicAuthApiKeyAuth

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/report/api/report/ HTTP/1.1
Host: 
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

post

Adaptation of DRF ModelViewSet

Authorizations

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/services/services/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

201

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Path parameters

idstringRequired

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

put

Adaptation of DRF ModelViewSet

Authorizations

Path parameters

idstringRequired

Responses

put

HTTPcURLJavaScriptPython

PUT /ux/common/services/services/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

delete

Adaptation of DRF ModelViewSet

Authorizations

Path parameters

idstringRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /ux/common/services/services/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/add-channelmap-data/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

post

Adaptation of DRF ModelViewSet

Authorizations

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/services/services/add-service/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/add-service-profile/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/all-circuits/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/check-service-name/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

post

Adaptation of DRF ModelViewSet

Authorizations

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/services/services/ci_name/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

post

Adaptation of DRF ModelViewSet

Authorizations

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/services/services/circuit-paths/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/delete-service/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/delete-service-profile/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/ethernet-service-profiles/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/ethernet-services/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

post

Adaptation of DRF ModelViewSet

Authorizations

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/services/services/ethernet-services/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/ethernet-services-paths/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/fetch-status/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/filter-options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/get-olt-details/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/get-vcg/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/node-list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/port-list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/service-activate-deactivate/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

post

Adaptation of DRF ModelViewSet

Authorizations

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/services/services/service-confirmation/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/service-locations/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

post

Adaptation of DRF ModelViewSet

Authorizations

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/services/services/service-nodes-coordinates/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

Gets a list of Services profiles

get

This endpoint is used to fetch all the Services profiles in the current organization (works based on token used to authorize)

Authorizations

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/service-related/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/services/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

post

Adaptation of DRF ModelViewSet

Authorizations

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/services/services/services/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/stm-jklm/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/topology-service/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Adaptation of DRF ModelViewSet

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/common/services/services/update-service-status/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Authorizations

Responses

application/json

object[]Optional

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

get

HTTPcURLJavaScriptPython

GET /ux/ims/purge_configuration/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "text",
    "config_id": "text",
    "purge_UUID": "text",
    "organization": "text",
    "created_by": 1,
    "modified_by": 1,
    "creation_time": "2025-04-18T23:21:00.255Z",
    "last_update_time": "2025-04-18T23:21:00.255Z",
    "is_enabled": true,
    "purge_configuration": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

Creates a new purge Configuration

post

This endpoint is used to save a Purge configuration for the current organization

Authorizations

Body

Other propertiesanyOptional

Responses

post

HTTPcURLJavaScriptPython

POST /ux/ims/purge_configuration/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 214

{
  "rawdata": 31,
  "hoursdata": 32,
  "daydata": 366,
  "events": 366,
  "traps": 366,
  "syslog": 366,
  "download jobs": 92,
  "upload job": 92,
  "incident": 2000,
  "problem": 2000,
  "request": 2000,
  "change": 2000,
  "audits": 366,
  "assets scan history": 92
}

201

No response body

No content

get

Authorizations

Path parameters

idstringRequired

Responses

application/json

objectOptional

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

get

HTTPcURLJavaScriptPython

GET /ux/ims/purge_configuration/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "config_id": "text",
  "purge_UUID": "text",
  "organization": "text",
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-04-18T23:21:00.255Z",
  "last_update_time": "2025-04-18T23:21:00.255Z",
  "is_enabled": true,
  "purge_configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

put

Authorizations

Path parameters

idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

config_idstring · max: 255Required

purge_UUIDstring · max: 255Optional

organizationstring · max: 255Optional

created_byintegerOptional

modified_byintegerOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

is_enabledbooleanOptionalDefault: true

purge_configurationobjectOptional

Responses

application/json

objectOptional

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

put

HTTPcURLJavaScriptPython

PUT /ux/ims/purge_configuration/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 261

{
  "config_id": "text",
  "purge_UUID": "text",
  "organization": "text",
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-04-18T23:21:00.255Z",
  "last_update_time": "2025-04-18T23:21:00.255Z",
  "is_enabled": true,
  "purge_configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "config_id": "text",
  "purge_UUID": "text",
  "organization": "text",
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-04-18T23:21:00.255Z",
  "last_update_time": "2025-04-18T23:21:00.255Z",
  "is_enabled": true,
  "purge_configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

delete

Authorizations

Path parameters

idstringRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /ux/ims/purge_configuration/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

Gets a purge Configuration with the given config_id

get

This endpoint is used to fetch purge Configuration details in the current organization

Authorizations

Responses

application/json

objectOptional

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

get

HTTPcURLJavaScriptPython

GET /ux/ims/purge_configuration/fetch-save-data/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "config_id": "text",
  "purge_UUID": "text",
  "organization": "text",
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-04-18T23:21:00.255Z",
  "last_update_time": "2025-04-18T23:21:00.255Z",
  "is_enabled": true,
  "purge_configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

get

Authorizations

Responses

application/json

objectOptional

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

get

HTTPcURLJavaScriptPython

GET /ux/ims/purge_configuration/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "config_id": "text",
  "purge_UUID": "text",
  "organization": "text",
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-04-18T23:21:00.255Z",
  "last_update_time": "2025-04-18T23:21:00.255Z",
  "is_enabled": true,
  "purge_configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/oidc/config/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

post

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

post

HTTPcURLJavaScriptPython

POST /ux/oidc/config/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

201

No response body

No content

get

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Responses

get

HTTPcURLJavaScriptPython

GET /ux/oidc/config/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

put

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Responses

put

HTTPcURLJavaScriptPython

PUT /ux/oidc/config/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

delete

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /ux/oidc/config/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

post

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

post

HTTPcURLJavaScriptPython

POST /ux/oidc/config/enable-disable-config/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/oidc/config/get-oidc/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/saml/config/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

post

Authorizations

Responses

post

HTTPcURLJavaScriptPython

POST /ux/saml/config/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

201

No response body

No content

get

Authorizations

Path parameters

idstringRequired

Responses

get

HTTPcURLJavaScriptPython

GET /ux/saml/config/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

put

Authorizations

Path parameters

idstringRequired

Responses

put

HTTPcURLJavaScriptPython

PUT /ux/saml/config/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

delete

Authorizations

Path parameters

idstringRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /ux/saml/config/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

post

Authorizations

Responses

post

HTTPcURLJavaScriptPython

POST /ux/saml/config/enable-disable-saml-config/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content

get

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /ux/saml/config/get-saml/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No response body

No content