Incident
get
API endpoint that allows Incident to be viewed or edited.
Authorizations
Responses
200
No response body
No content
get
GET /ux/sd/inci/conversation/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
No response body
No content
post
API endpoint that allows Incident to be viewed or edited.
Authorizations
Responses
201
No response body
No content
post
POST /ux/sd/inci/conversation/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
201
No response body
No content
get
API endpoint that allows Incident to be viewed or edited.
Authorizations
Path parameters
idstringRequired
Responses
200
No response body
No content
get
GET /ux/sd/inci/conversation/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
No response body
No content
put
API endpoint that allows Incident to be viewed or edited.
Authorizations
Path parameters
idstringRequired
Responses
200
No response body
No content
put
PUT /ux/sd/inci/conversation/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
No response body
No content
delete
API endpoint that allows Incident to be viewed or edited.
Authorizations
Path parameters
idstringRequired
Responses
204
No response body
No content
delete
DELETE /ux/sd/inci/conversation/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
204
No response body
No content
This endpoint is used to fetch all the incidents in the current organization
Authorizations
Query parameters
items_per_pageintegerRequired
Items Per Page
pageintegerRequired
Page Number
reversebooleanOptional
Sorting Order
sortstringOptional
Sorting Key
Responses
200Success
application/json
get
GET /ux/sd/inci/incident/?items_per_page=1&page=1 HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200Success
[
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
]This endpoint is used to save a new incident for the current organization
Authorizations
Body
Other propertiesanyOptional
Responses
201
No response body
No content
post
POST /ux/sd/inci/incident/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 940
{
"summary": "VPN Issue",
"description": "",
"catalogue": "",
"impact_service": "",
"impact_service_name": "service1",
"service_classification": "",
"service_classification_name": "",
"state": "Open",
"state_id": 1,
"status": "New",
"status_id": 1,
"urgency_id": 3,
"urgency": "Low",
"priority_id": 5,
"priority": "Very Low",
"impact": "Department",
"impact_id": 3,
"incident_source": {
"id": 1,
"name": "Web"
},
"resolution_type": "",
"is_first_call": "",
"incident_type": {
"id": 1,
"name": "Incident",
"prefix": "inci"
},
"requester_id": "",
"requester_name": "Test req",
"requester_email": "[email protected]",
"requester_phone": "7778889999",
"reporter_name": "",
"reporter_email": "",
"reporter_phone": "",
"watcher": "",
"hold_config": {},
"support_group": "",
"assignee": "",
"escalation": {},
"tag": [],
"assets": [],
"config": {},
"reference": {},
"template_info": {},
"closure_info": {},
"approval_config": {},
"custom_field": [
{}
],
"attachment": {},
"api_link": {},
"lock_config": {},
"field_service_config": {},
"closure_note": ""
}201
No response body
No content
This endpoint is used to fetch a incident details in the current organization
Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /ux/sd/inci/incident/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}This endpoint is used to edit an existing incident for the current organization
Authorizations
Path parameters
idstringRequired
Body
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.
incident_idstring · max: 25Required
display_idstring · max: 50Optional
is_merge_incidentbooleanOptional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
Responses
200Success
application/json
put
PUT /ux/sd/inci/incident/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1105
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}This endpoint is used to delete an existing incident for the current organization
Authorizations
Path parameters
idstringRequired
Responses
204
No response body
No content
delete
DELETE /ux/sd/inci/incident/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
204
No response body
No content
This endpoint is used to add new attachments.
Authorizations
Body
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.
incident_idstring · max: 25Required
display_idstring · max: 50Optional
is_merge_incidentbooleanOptional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
Responses
200Success
application/json
post
POST /ux/sd/inci/incident/add-attachment/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1105
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}This endpoint is used to fetch the attachments.
Authorizations
Responses
200Success
application/json
get
GET /ux/sd/inci/incident/attachment/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}post
API endpoint that allows Incident to be viewed or edited.
Authorizations
Body
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.
incident_idstring · max: 25Required
display_idstring · max: 50Optional
is_merge_incidentbooleanOptional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
Responses
200Success
application/json
post
POST /ux/sd/inci/incident/bulk_retry_api/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1105
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}post
API endpoint that allows Incident to be viewed or edited.
Authorizations
Body
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.
incident_idstring · max: 25Required
display_idstring · max: 50Optional
is_merge_incidentbooleanOptional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
Responses
200Success
application/json
post
POST /ux/sd/inci/incident/close_inci_request/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1105
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}post
API endpoint that allows Incident to be viewed or edited.
Authorizations
Body
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.
incident_idstring · max: 25Required
display_idstring · max: 50Optional
is_merge_incidentbooleanOptional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
Responses
200Success
application/json
post
POST /ux/sd/inci/incident/delete_incident/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1105
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}get
API endpoint that allows Incident to be viewed or edited.
Authorizations
Responses
200Success
application/json
get
GET /ux/sd/inci/incident/feedback/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}get
API endpoint that allows Incident to be viewed or edited.
Authorizations
Responses
200Success
application/json
get
GET /ux/sd/inci/incident/impacted_asset/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}post
API endpoint that allows Incident to be viewed or edited.
Authorizations
Body
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.
incident_idstring · max: 25Required
display_idstring · max: 50Optional
is_merge_incidentbooleanOptional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
Responses
200Success
application/json
post
POST /ux/sd/inci/incident/inci_reopen/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1105
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}post
API endpoint that allows Incident to be viewed or edited.
Authorizations
Body
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.
incident_idstring · max: 25Required
display_idstring · max: 50Optional
is_merge_incidentbooleanOptional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
Responses
200Success
application/json
post
POST /ux/sd/inci/incident/inci_resolve/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1105
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}get
API endpoint that allows Incident to be viewed or edited.
Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /ux/sd/inci/incident/incident-data/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}get
API endpoint that allows Incident to be viewed or edited.
Authorizations
Responses
200Success
application/json
get
GET /ux/sd/inci/incident/options/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}This endpoint is used to get the rich text data.
Authorizations
Responses
200Success
application/json
get
GET /ux/sd/inci/incident/process-rich-text/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}get
API endpoint that allows Incident to be viewed or edited.
Authorizations
Responses
200Success
application/json
get
GET /ux/sd/inci/incident/requester_search/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}This endpoint is used to save the rich text data.
Authorizations
Body
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.
incident_idstring · max: 25Required
display_idstring · max: 50Optional
is_merge_incidentbooleanOptional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
Responses
200Success
application/json
post
POST /ux/sd/inci/incident/save-rich-text/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1105
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}post
API endpoint that allows Incident to be viewed or edited.
Authorizations
Body
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.
incident_idstring · max: 25Required
display_idstring · max: 50Optional
is_merge_incidentbooleanOptional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
Responses
200Success
application/json
post
POST /ux/sd/inci/incident/workflow_options_map/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1105
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}get
API endpoint that allows Incident to be viewed or edited.
Authorizations
Responses
200Success
application/json
get
GET /ux/sd/inci/incident/workflow_status/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
"incident_id": "text",
"display_id": "text",
"is_merge_incident": true,
"is_archive": true,
"unread_mail": true,
"requester": {
"keys": "text",
"values": "text",
"queryparam": true
},
"config": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reporter_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"basic_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"reference": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"source_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"template_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"impacted_asset": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"close_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"current_watcher": [],
"current_assignment_info": {
"keys": "text",
"values": "text",
"queryparam": true
},
"custom_field": [
{
"keys": "text",
"values": "text",
"queryparam": true
}
],
"tag": [],
"kb": [],
"custom_field_data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"creation_time": "2025-08-31T16:08:45.429Z",
"created_by_id": "text",
"last_update_time": "2025-08-31T16:08:45.429Z",
"updated_by_id": "text",
"location": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}