Checklist

Gets a list of checklist

get

This endpoint is used to fetch all the checklist 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

HTTPcURLJavaScriptPython

GET /ux/sd/checklist/checklist/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "name": "text",
    "checklist_id": "text",
    "module_name": "text",
    "workflow_name": "text",
    "catalogue_service_name": "text",
    "workflow_type": "text",
    "status_name": "text"
  }
]

Creates a new checklist

post

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

Authorizations

Body

Other propertiesanyOptional

Responses

201

No response body

post

HTTPcURLJavaScriptPython

POST /ux/sd/checklist/checklist/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "checklist": "checklist1"
}

201

No response body

No content

Gets a checklist with the given id

get

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

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/sd/checklist/checklist/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "name": "text",
  "checklist_id": "text",
  "module_name": "text",
  "workflow_name": "text",
  "catalogue_service_name": "text",
  "workflow_type": "text",
  "status_name": "text"
}

Edits the checklist with given id

put

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

Authorizations

Path parameters

idstringRequired

Body

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

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

namestring · max: 255Optional

checklist_idstringOptional

module_namestringRead-onlyRequired

workflow_namestringRead-onlyRequired

catalogue_service_namestringRead-onlyRequired

workflow_typestringRead-onlyRequired

status_namestringRead-onlyRequired

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

PUT /ux/sd/checklist/checklist/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "name": "text",
  "checklist_id": "text"
}

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

200Success

{
  "name": "text",
  "checklist_id": "text",
  "module_name": "text",
  "workflow_name": "text",
  "catalogue_service_name": "text",
  "workflow_type": "text",
  "status_name": "text"
}

Deletes the checklist with given id

delete

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

Authorizations

Path parameters

idstringRequired

Responses

204

No response body

delete

HTTPcURLJavaScriptPython

DELETE /ux/sd/checklist/checklist/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

Get the options for the Checklist configuration

get

This endpoint is used to get the default options for checklist config

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/sd/checklist/checklist/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "name": "text",
  "checklist_id": "text",
  "module_name": "text",
  "workflow_name": "text",
  "catalogue_service_name": "text",
  "workflow_type": "text",
  "status_name": "text"
}

Get the status options for selected impact service for the Checklist configuration

get

This endpoint is used to get the status options for selected catalogue service

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/sd/checklist/checklist/status_options_based_on_service/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "name": "text",
  "checklist_id": "text",
  "module_name": "text",
  "workflow_name": "text",
  "catalogue_service_name": "text",
  "workflow_type": "text",
  "status_name": "text"
}