Incident

get

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200

No response body

No content

get
/ux/sd/inci/conversation/
200

No response body

No content

post

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
post
/ux/sd/inci/conversation/
201

No response body

No content

get

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
chevron-right
200

No response body

No content

get
/ux/sd/inci/conversation/{id}/
200

No response body

No content

put

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
chevron-right
200

No response body

No content

put
/ux/sd/inci/conversation/{id}/
200

No response body

No content

delete

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
delete
/ux/sd/inci/conversation/{id}/
204

No response body

No content

Gets a list of incidents

get

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

Authorizations
AuthorizationstringRequired
Query parameters
items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses
chevron-right
200Success
application/json
get
/ux/sd/inci/incident/
200Success

Creates a new incident

post

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

Authorizations
AuthorizationstringRequired
Body
Other propertiesanyOptional
Responses
post
/ux/sd/inci/incident/
201

No response body

No content

Gets a incident with the given id

get

This endpoint is used to fetch a incident details in the current organization

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/sd/inci/incident/{id}/
200Success

Edits the incident with given id

put

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

Authorizations
AuthorizationstringRequired
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
chevron-right
200Success
application/json
put
/ux/sd/inci/incident/{id}/
200Success

Deletes the incident with given id

delete

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

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
delete
/ux/sd/inci/incident/{id}/
204

No response body

No content

Add attachments for the selected incident.

post

This endpoint is used to add new attachments.

Authorizations
AuthorizationstringRequired
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
chevron-right
200Success
application/json
post
/ux/sd/inci/incident/add-attachment/
200Success

Gets attachments for the selected incident.

get

This endpoint is used to fetch the attachments.

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/sd/inci/incident/attachment/
200Success
post

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
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
chevron-right
200Success
application/json
post
/ux/sd/inci/incident/bulk_retry_api/
200Success
post

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
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
chevron-right
200Success
application/json
post
/ux/sd/inci/incident/close_inci_request/
200Success
post

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
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
chevron-right
200Success
application/json
post
/ux/sd/inci/incident/delete_incident/
200Success
get

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/sd/inci/incident/feedback/
200Success
get

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/sd/inci/incident/impacted_asset/
200Success
post

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
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
chevron-right
200Success
application/json
post
/ux/sd/inci/incident/inci_reopen/
200Success
post

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
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
chevron-right
200Success
application/json
post
/ux/sd/inci/incident/inci_resolve/
200Success
get

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/sd/inci/incident/incident-data/{id}/
200Success
get

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/sd/inci/incident/options/
200Success

Get rich text data

get

This endpoint is used to get the rich text data.

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/sd/inci/incident/process-rich-text/
200Success

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/sd/inci/incident/requester_search/
200Success

Save rich text data

post

This endpoint is used to save the rich text data.

Authorizations
AuthorizationstringRequired
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
chevron-right
200Success
application/json
post
/ux/sd/inci/incident/save-rich-text/
200Success
post

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
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
chevron-right
200Success
application/json
post
/ux/sd/inci/incident/workflow_options_map/
200Success
get

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
get
/ux/sd/inci/incident/workflow_status/
200Success

Last updated