Checklist
This endpoint is used to fetch all the checklist in the current organization
Items Per Page
Page Number
Sorting Order
Sorting Key
GET /ux/sd/checklist/checklist/?items_per_page=1&page=1 HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"name": "text",
"checklist_id": "text",
"module_name": "text",
"workflow_name": "text",
"catalogue_service_name": "text",
"workflow_type": "text",
"status_name": "text"
}
]This endpoint is used to save a new checklist for the current organization
No response body
No content
POST /ux/sd/checklist/checklist/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"checklist": "checklist1"
}No response body
No content
This endpoint is used to fetch a business_rule details in the current organization
GET /ux/sd/checklist/checklist/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"name": "text",
"checklist_id": "text",
"module_name": "text",
"workflow_name": "text",
"catalogue_service_name": "text",
"workflow_type": "text",
"status_name": "text"
}This endpoint is used to edit an existing checklist for the current organization
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).
For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField and probably will work wrong.
PUT /ux/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"
}{
"name": "text",
"checklist_id": "text",
"module_name": "text",
"workflow_name": "text",
"catalogue_service_name": "text",
"workflow_type": "text",
"status_name": "text"
}This endpoint is used to delete an existing checklist for the current organization
No response body
No content
DELETE /ux/sd/checklist/checklist/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
This endpoint is used to get the default options for checklist config
GET /ux/sd/checklist/checklist/options/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"name": "text",
"checklist_id": "text",
"module_name": "text",
"workflow_name": "text",
"catalogue_service_name": "text",
"workflow_type": "text",
"status_name": "text"
}This endpoint is used to get the status options for selected catalogue service
GET /ux/sd/checklist/checklist/status_options_based_on_service/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"name": "text",
"checklist_id": "text",
"module_name": "text",
"workflow_name": "text",
"catalogue_service_name": "text",
"workflow_type": "text",
"status_name": "text"
}