Device Template

Gets a list of device_template

get

This endpoint is used to fetch all the device_template in the current organization

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

200Success

application/json

get

/ux/ims/device-template/

HTTPcURLJavaScriptPython

GET /ux/ims/device-template/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "text",
    "created_by_name": "text",
    "device_icon": "text",
    "sys_id": "text",
    "sysobjectid": "text",
    "organization": "text",
    "product": "text",
    "vendor": "text",
    "device_type": "text",
    "os_type": "text",
    "model": "text",
    "series": "text",
    "is_deleted": true,
    "modified_by": "text",
    "creation_time": "2026-01-22T13:43:13.907Z",
    "last_update_time": "2026-01-22T13:43:13.907Z",
    "created_by": "text",
    "vendor_icon": "text",
    "os_icon": "text",
    "device": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

Creates a new device_template

post

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

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Body

application/json

Other propertiesanyOptional

Responses

201

No response body

post

/ux/ims/device-template/

HTTPcURLJavaScriptPython

POST /ux/ims/device-template/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

201

No response body

No content

Gets a device_template details with the given id

get

This endpoint is used to fetch a device_template in the current organization

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idstringRequired

Responses

200Success

application/json

get

/ux/ims/device-template/{id}/

HTTPcURLJavaScriptPython

GET /ux/ims/device-template/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "created_by_name": "text",
  "device_icon": "text",
  "sys_id": "text",
  "sysobjectid": "text",
  "organization": "text",
  "product": "text",
  "vendor": "text",
  "device_type": "text",
  "os_type": "text",
  "model": "text",
  "series": "text",
  "is_deleted": true,
  "modified_by": "text",
  "creation_time": "2026-01-22T13:43:13.907Z",
  "last_update_time": "2026-01-22T13:43:13.907Z",
  "created_by": "text",
  "vendor_icon": "text",
  "os_icon": "text",
  "device": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

put

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

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

created_by_namestringRead-onlyRequired

device_iconstringRead-onlyRequired

sys_idstringRequired

sysobjectidstringRequired

organizationstringRequired

productstringOptional

vendorstringOptional

device_typestringOptional

os_typestringOptional

modelstringOptional

seriesstringOptional

is_deletedbooleanOptional

modified_bystringOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

created_bystringOptional

vendor_iconstringOptional

os_iconstringOptional

Responses

200Success

application/json

put

/ux/ims/device-template/{id}/

HTTPcURLJavaScriptPython

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

{
  "sys_id": "text",
  "sysobjectid": "text",
  "organization": "text",
  "product": "text",
  "vendor": "text",
  "device_type": "text",
  "os_type": "text",
  "model": "text",
  "series": "text",
  "is_deleted": true,
  "modified_by": "text",
  "creation_time": "2026-01-22T13:43:13.907Z",
  "last_update_time": "2026-01-22T13:43:13.907Z",
  "created_by": "text",
  "vendor_icon": "text",
  "os_icon": "text",
  "device": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

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

200Success

{
  "id": "text",
  "created_by_name": "text",
  "device_icon": "text",
  "sys_id": "text",
  "sysobjectid": "text",
  "organization": "text",
  "product": "text",
  "vendor": "text",
  "device_type": "text",
  "os_type": "text",
  "model": "text",
  "series": "text",
  "is_deleted": true,
  "modified_by": "text",
  "creation_time": "2026-01-22T13:43:13.907Z",
  "last_update_time": "2026-01-22T13:43:13.907Z",
  "created_by": "text",
  "vendor_icon": "text",
  "os_icon": "text",
  "device": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Deletes the device_template with given id

delete

This endpoint is used to delete an existing device_template for the current organization

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idstringRequired

Responses

204

No response body

delete

/ux/ims/device-template/{id}/

HTTPcURLJavaScriptPython

DELETE /ux/ims/device-template/{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

ApiKeyAuth

AuthorizationstringRequired

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

created_by_namestringRead-onlyRequired

device_iconstringRead-onlyRequired

sys_idstringRequired

sysobjectidstringRequired

organizationstringRequired

productstringOptional

vendorstringOptional

device_typestringOptional

os_typestringOptional

modelstringOptional

seriesstringOptional

is_deletedbooleanOptional

modified_bystringOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

created_bystringOptional

vendor_iconstringOptional

os_iconstringOptional

Responses

200Success

application/json

post

/ux/ims/device-template/create-templates/

HTTPcURLJavaScriptPython

POST /ux/ims/device-template/create-templates/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 396

{
  "sys_id": "text",
  "sysobjectid": "text",
  "organization": "text",
  "product": "text",
  "vendor": "text",
  "device_type": "text",
  "os_type": "text",
  "model": "text",
  "series": "text",
  "is_deleted": true,
  "modified_by": "text",
  "creation_time": "2026-01-22T13:43:13.907Z",
  "last_update_time": "2026-01-22T13:43:13.907Z",
  "created_by": "text",
  "vendor_icon": "text",
  "os_icon": "text",
  "device": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

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

200Success

{
  "id": "text",
  "created_by_name": "text",
  "device_icon": "text",
  "sys_id": "text",
  "sysobjectid": "text",
  "organization": "text",
  "product": "text",
  "vendor": "text",
  "device_type": "text",
  "os_type": "text",
  "model": "text",
  "series": "text",
  "is_deleted": true,
  "modified_by": "text",
  "creation_time": "2026-01-22T13:43:13.907Z",
  "last_update_time": "2026-01-22T13:43:13.907Z",
  "created_by": "text",
  "vendor_icon": "text",
  "os_icon": "text",
  "device": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

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

created_by_namestringRead-onlyRequired

device_iconstringRead-onlyRequired

sys_idstringRequired

sysobjectidstringRequired

organizationstringRequired

productstringOptional

vendorstringOptional

device_typestringOptional

os_typestringOptional

modelstringOptional

seriesstringOptional

is_deletedbooleanOptional

modified_bystringOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

created_bystringOptional

vendor_iconstringOptional

os_iconstringOptional

Responses

200Success

application/json

post

/ux/ims/device-template/csv_cols/

HTTPcURLJavaScriptPython

POST /ux/ims/device-template/csv_cols/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 396

{
  "sys_id": "text",
  "sysobjectid": "text",
  "organization": "text",
  "product": "text",
  "vendor": "text",
  "device_type": "text",
  "os_type": "text",
  "model": "text",
  "series": "text",
  "is_deleted": true,
  "modified_by": "text",
  "creation_time": "2026-01-22T13:43:13.907Z",
  "last_update_time": "2026-01-22T13:43:13.907Z",
  "created_by": "text",
  "vendor_icon": "text",
  "os_icon": "text",
  "device": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

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

200Success

{
  "id": "text",
  "created_by_name": "text",
  "device_icon": "text",
  "sys_id": "text",
  "sysobjectid": "text",
  "organization": "text",
  "product": "text",
  "vendor": "text",
  "device_type": "text",
  "os_type": "text",
  "model": "text",
  "series": "text",
  "is_deleted": true,
  "modified_by": "text",
  "creation_time": "2026-01-22T13:43:13.907Z",
  "last_update_time": "2026-01-22T13:43:13.907Z",
  "created_by": "text",
  "vendor_icon": "text",
  "os_icon": "text",
  "device": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ims/device-template/download_csv/

HTTPcURLJavaScriptPython

GET /ux/ims/device-template/download_csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "created_by_name": "text",
  "device_icon": "text",
  "sys_id": "text",
  "sysobjectid": "text",
  "organization": "text",
  "product": "text",
  "vendor": "text",
  "device_type": "text",
  "os_type": "text",
  "model": "text",
  "series": "text",
  "is_deleted": true,
  "modified_by": "text",
  "creation_time": "2026-01-22T13:43:13.907Z",
  "last_update_time": "2026-01-22T13:43:13.907Z",
  "created_by": "text",
  "vendor_icon": "text",
  "os_icon": "text",
  "device": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

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

created_by_namestringRead-onlyRequired

device_iconstringRead-onlyRequired

sys_idstringRequired

sysobjectidstringRequired

organizationstringRequired

productstringOptional

vendorstringOptional

device_typestringOptional

os_typestringOptional

modelstringOptional

seriesstringOptional

is_deletedbooleanOptional

modified_bystringOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

created_bystringOptional

vendor_iconstringOptional

os_iconstringOptional

Responses

200Success

application/json

post

/ux/ims/device-template/multidelete/

HTTPcURLJavaScriptPython

POST /ux/ims/device-template/multidelete/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 396

{
  "sys_id": "text",
  "sysobjectid": "text",
  "organization": "text",
  "product": "text",
  "vendor": "text",
  "device_type": "text",
  "os_type": "text",
  "model": "text",
  "series": "text",
  "is_deleted": true,
  "modified_by": "text",
  "creation_time": "2026-01-22T13:43:13.907Z",
  "last_update_time": "2026-01-22T13:43:13.907Z",
  "created_by": "text",
  "vendor_icon": "text",
  "os_icon": "text",
  "device": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

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

200Success

{
  "id": "text",
  "created_by_name": "text",
  "device_icon": "text",
  "sys_id": "text",
  "sysobjectid": "text",
  "organization": "text",
  "product": "text",
  "vendor": "text",
  "device_type": "text",
  "os_type": "text",
  "model": "text",
  "series": "text",
  "is_deleted": true,
  "modified_by": "text",
  "creation_time": "2026-01-22T13:43:13.907Z",
  "last_update_time": "2026-01-22T13:43:13.907Z",
  "created_by": "text",
  "vendor_icon": "text",
  "os_icon": "text",
  "device": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ims/device-template/options/

HTTPcURLJavaScriptPython

GET /ux/ims/device-template/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "created_by_name": "text",
  "device_icon": "text",
  "sys_id": "text",
  "sysobjectid": "text",
  "organization": "text",
  "product": "text",
  "vendor": "text",
  "device_type": "text",
  "os_type": "text",
  "model": "text",
  "series": "text",
  "is_deleted": true,
  "modified_by": "text",
  "creation_time": "2026-01-22T13:43:13.907Z",
  "last_update_time": "2026-01-22T13:43:13.907Z",
  "created_by": "text",
  "vendor_icon": "text",
  "os_icon": "text",
  "device": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ims/device-template/res-config-options/

HTTPcURLJavaScriptPython

GET /ux/ims/device-template/res-config-options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "created_by_name": "text",
  "device_icon": "text",
  "sys_id": "text",
  "sysobjectid": "text",
  "organization": "text",
  "product": "text",
  "vendor": "text",
  "device_type": "text",
  "os_type": "text",
  "model": "text",
  "series": "text",
  "is_deleted": true,
  "modified_by": "text",
  "creation_time": "2026-01-22T13:43:13.907Z",
  "last_update_time": "2026-01-22T13:43:13.907Z",
  "created_by": "text",
  "vendor_icon": "text",
  "os_icon": "text",
  "device": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

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

created_by_namestringRead-onlyRequired

device_iconstringRead-onlyRequired

sys_idstringRequired

sysobjectidstringRequired

organizationstringRequired

productstringOptional

vendorstringOptional

device_typestringOptional

os_typestringOptional

modelstringOptional

seriesstringOptional

is_deletedbooleanOptional

modified_bystringOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

created_bystringOptional

vendor_iconstringOptional

os_iconstringOptional

Responses

200Success

application/json

post

/ux/ims/device-template/sys-object-resync/

HTTPcURLJavaScriptPython

POST /ux/ims/device-template/sys-object-resync/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 396

{
  "sys_id": "text",
  "sysobjectid": "text",
  "organization": "text",
  "product": "text",
  "vendor": "text",
  "device_type": "text",
  "os_type": "text",
  "model": "text",
  "series": "text",
  "is_deleted": true,
  "modified_by": "text",
  "creation_time": "2026-01-22T13:43:13.907Z",
  "last_update_time": "2026-01-22T13:43:13.907Z",
  "created_by": "text",
  "vendor_icon": "text",
  "os_icon": "text",
  "device": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

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

200Success

{
  "id": "text",
  "created_by_name": "text",
  "device_icon": "text",
  "sys_id": "text",
  "sysobjectid": "text",
  "organization": "text",
  "product": "text",
  "vendor": "text",
  "device_type": "text",
  "os_type": "text",
  "model": "text",
  "series": "text",
  "is_deleted": true,
  "modified_by": "text",
  "creation_time": "2026-01-22T13:43:13.907Z",
  "last_update_time": "2026-01-22T13:43:13.907Z",
  "created_by": "text",
  "vendor_icon": "text",
  "os_icon": "text",
  "device": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

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

created_by_namestringRead-onlyRequired

device_iconstringRead-onlyRequired

sys_idstringRequired

sysobjectidstringRequired

organizationstringRequired

productstringOptional

vendorstringOptional

device_typestringOptional

os_typestringOptional

modelstringOptional

seriesstringOptional

is_deletedbooleanOptional

modified_bystringOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

created_bystringOptional

vendor_iconstringOptional

os_iconstringOptional

Responses

200Success

application/json

post

/ux/ims/device-template/upload-csv/

HTTPcURLJavaScriptPython

POST /ux/ims/device-template/upload-csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 396

{
  "sys_id": "text",
  "sysobjectid": "text",
  "organization": "text",
  "product": "text",
  "vendor": "text",
  "device_type": "text",
  "os_type": "text",
  "model": "text",
  "series": "text",
  "is_deleted": true,
  "modified_by": "text",
  "creation_time": "2026-01-22T13:43:13.907Z",
  "last_update_time": "2026-01-22T13:43:13.907Z",
  "created_by": "text",
  "vendor_icon": "text",
  "os_icon": "text",
  "device": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

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

200Success

{
  "id": "text",
  "created_by_name": "text",
  "device_icon": "text",
  "sys_id": "text",
  "sysobjectid": "text",
  "organization": "text",
  "product": "text",
  "vendor": "text",
  "device_type": "text",
  "os_type": "text",
  "model": "text",
  "series": "text",
  "is_deleted": true,
  "modified_by": "text",
  "creation_time": "2026-01-22T13:43:13.907Z",
  "last_update_time": "2026-01-22T13:43:13.907Z",
  "created_by": "text",
  "vendor_icon": "text",
  "os_icon": "text",
  "device": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ims/device-template/verify-oid-exists/

HTTPcURLJavaScriptPython

GET /ux/ims/device-template/verify-oid-exists/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "created_by_name": "text",
  "device_icon": "text",
  "sys_id": "text",
  "sysobjectid": "text",
  "organization": "text",
  "product": "text",
  "vendor": "text",
  "device_type": "text",
  "os_type": "text",
  "model": "text",
  "series": "text",
  "is_deleted": true,
  "modified_by": "text",
  "creation_time": "2026-01-22T13:43:13.907Z",
  "last_update_time": "2026-01-22T13:43:13.907Z",
  "created_by": "text",
  "vendor_icon": "text",
  "os_icon": "text",
  "device": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}