Request Process

get

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
get
/ux/sd/req/conversation/
200

No response body

No content

post

API endpoint that allows Incident to be viewed or edited.

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

No response body

No content

get

API endpoint that allows Incident to be viewed or edited.

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
get
/ux/sd/req/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
put
/ux/sd/req/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/req/conversation/{id}/
204

No response body

No content

Gets a list of requests

get

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

Authorizations
AuthorizationstringRequired
Query parameters
items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses
get
/ux/sd/req/request_process/
200Success

Creates a new request

post

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

Authorizations
AuthorizationstringRequired
Body
Other propertiesanyOptional
Responses
post
/ux/sd/req/request_process/
201

No response body

No content

Gets a request with the given id

get

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

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
get
/ux/sd/req/request_process/{id}/
200Success

Edits the request with given id

put

This endpoint is used to edit an existing request 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.

request_idstring · max: 25Required
display_idstring · max: 50Optional
is_merge_requestbooleanOptional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
Responses
put
/ux/sd/req/request_process/{id}/
200Success

Deletes the request with given id

delete

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

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
delete
/ux/sd/req/request_process/{id}/
204

No response body

No content

Gets attachments for the selected request.

get

This endpoint is used to fetch the attachments.

Authorizations
AuthorizationstringRequired
Responses
get
/ux/sd/req/request_process/attachment/
200Success
post

API endpoint that allows Request 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.

request_idstring · max: 25Required
display_idstring · max: 50Optional
is_merge_requestbooleanOptional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
Responses
post
/ux/sd/req/request_process/bulk_retry_api/
200Success
get

API endpoint that allows Request to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
get
/ux/sd/req/request_process/check_list/
200Success

Gets history for the selected request.

get

This endpoint is used to fetch the history.

Authorizations
AuthorizationstringRequired
Responses
get
/ux/sd/req/request_process/history/
200Success
get

API endpoint that allows Request to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
get
/ux/sd/req/request_process/options/
200Success

Get rich text data

get

This endpoint is used to get the rich text data.

Authorizations
AuthorizationstringRequired
Responses
get
/ux/sd/req/request_process/process-rich-text/
200Success
get

API endpoint that allows Request to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
get
/ux/sd/req/request_process/requ_check_list/
200Success
get

API endpoint that allows Request to be viewed or edited.

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
get
/ux/sd/req/request_process/request-data/{id}/
200Success

API endpoint that allows Request to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
get
/ux/sd/req/request_process/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.

request_idstring · max: 25Required
display_idstring · max: 50Optional
is_merge_requestbooleanOptional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
Responses
post
/ux/sd/req/request_process/save-rich-text/
200Success
post

API endpoint that allows Request 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.

request_idstring · max: 25Required
display_idstring · max: 50Optional
is_merge_requestbooleanOptional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
Responses
post
/ux/sd/req/request_process/update_requ_checklist/
200Success
post

API endpoint that allows Request 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.

request_idstring · max: 25Required
display_idstring · max: 50Optional
is_merge_requestbooleanOptional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
Responses
post
/ux/sd/req/request_process/upload-csv/
200Success
post

API endpoint that allows Request 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.

request_idstring · max: 25Required
display_idstring · max: 50Optional
is_merge_requestbooleanOptional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
Responses
post
/ux/sd/req/request_process/workflow_options_map/
200Success
get

API endpoint that allows Request to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
get
/ux/sd/req/request_process/workflow_status/
200Success

Last updated