Workflow

API for workflow

Check out workflow documentation for more details.

get
Workflow List

/tables/workflow/list/{level}/{sid}/{serializer}/
This endpoint allows you to get a list of workflows.
Request
Response
Path Parameters
level
required
string
organization
sid
required
string
organization sid
serializer
required
string
name, list, detail
Headers
token
required
string
Authentication token
Query Parameters
table__sid
optional
boolean
The workflow is table specific, provide table__sid to query the workflow specific to a table
200: OK
Cake successfully retrieved.
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 3,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"table": {
"name": "xxx",
"sid": "xxx"
},
"parent": null,
"name": "xxx",
"description": "xxx",
"number_of_steps": 4,
"is_archived": false,
"updated_by": "xxx",
"date_updated": "2019-07-03T06:15:01.667876Z",
"date_created": "2019-06-29T07:31:31.706125Z",
"change_permission": true
},
]
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
Open to Admin, Manager, and Member
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct

post
Workflow List

/tables/workflow/list/{level}/{sid}/{serializer}/
This endpoint allows you to create a list of workflows
Request
Response
Path Parameters
level
required
string
organization
sid
required
string
organization sid
serializer
required
string
detail
Headers
token
required
string
Authentication token
Query Parameters
table__sid
required
string
Body Parameters
parent
optional
number
name
required
string
description
optional
string
201: Created
{
"sid": "xxx",
"table": {
"name": "xxx",
"sid": "xxx"
},
"parent": null,
"name": "xxx",
"description": "xxx",
"number_of_steps": 4,
"is_archived": false,
"updated_by": "xxx",
"date_updated": "2019-07-03T06:15:01.667876Z",
"date_created": "2019-06-29T07:31:31.706125Z",
"change_permission": true
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
Open to Admin
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct
Missing table__sid in get parameters
Wrong table sid - the provided table sid is not correct

get
Workflow Detail

/tables/workflow/detail/{sid}/
Request
Response
Path Parameters
sid
required
string
Headers
token
required
string
200: OK
{
"sid": "xxx",
"table": {
"name": "xxx",
"sid": "xxx"
},
"parent": null,
"name": "xxx",
"description": "xxx",
"number_of_steps": 4,
"is_archived": false,
"updated_by": "xxx",
"date_updated": "2019-07-03T06:15:01.667876Z",
"date_created": "2019-06-29T07:31:31.706125Z",
"change_permission": true
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
Open to Admin, Manager and Member
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct

patch
Workflow Detail

/tables/workflow/detail/{sid}/
Operation level: Admin
Request
Response
Path Parameters
sid
required
string
Headers
token
required
string
Body Parameters
parent
optional
number
name
optional
string
description
optional
string
is_archived
optional
boolean
200: OK
{
"sid": "xxx",
"table": {
"name": "xxx",
"sid": "xxx"
},
"parent": null,
"name": "xxx",
"description": "xxx",
"number_of_steps": 4,
"is_archived": false,
"updated_by": "xxx",
"date_updated": "2019-07-03T06:15:01.667876Z",
"date_created": "2019-06-29T07:31:31.706125Z",
"change_permission": true
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
Open to Admin
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct

delete
Workflow Detail

/tables/workflow/detail/{sid}/
Request
Response
Path Parameters
sid
required
string
Headers
token
required
string
204: No Content
{}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
Open to Admin
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct