Device Template
This endpoint is used to fetch all the device_template in the current organization
Items Per Page
Page Number
Sorting Order
Sorting Key
GET /ux/ims/device-template/?items_per_page=1&page=1 HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
]This endpoint is used to save a new device_template for the current organization
No response body
No content
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"
}No response body
No content
This endpoint is used to fetch a device_template in the current organization
GET /ux/ims/device-template/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}API endpoint that allows users to be viewed or edited.
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 /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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}{
"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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}This endpoint is used to delete an existing device_template for the current organization
No response body
No content
DELETE /ux/ims/device-template/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
API endpoint that allows users to be viewed or edited.
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 /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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}{
"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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}API endpoint that allows users to be viewed or edited.
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 /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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}{
"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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}API endpoint that allows users to be viewed or edited.
GET /ux/ims/device-template/download_csv/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}API endpoint that allows users to be viewed or edited.
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 /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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}{
"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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}API endpoint that allows users to be viewed or edited.
GET /ux/ims/device-template/options/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}API endpoint that allows users to be viewed or edited.
GET /ux/ims/device-template/res-config-options/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}API endpoint that allows users to be viewed or edited.
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 /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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}{
"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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}API endpoint that allows users to be viewed or edited.
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 /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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}{
"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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}API endpoint that allows users to be viewed or edited.
GET /ux/ims/device-template/verify-oid-exists/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"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": "2025-08-30T17:42:11.919Z",
"last_update_time": "2025-08-30T17:42:11.919Z",
"created_by": "text",
"vendor_icon": "text",
"os_icon": "text",
"device": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}