Step

Step API

Check out Step documentation for more details.

get
Step List

/tables/step/list/{level}/{sid}/{serializer}/
Request
Response
Path Parameters
level
required
string
sid
required
string
serializer
required
string
Headers
token
required
string
Query Parameters
widget__sid
optional
string
200: OK
{
"page_size": 10,
"page_number": 1,
"page_count": 3,
"count": 21,
"next": "http://127.0.0.1:8000/tables/step/list/organization/ehkn0a40x1glqvAFKP/detail/?page=2",
"previous": null,
"add_permission": false,
"results": [
{
"sid": "xxx",
"table": {
"name": "xxx",
"sid": "xxx"
},
"workflow": {
"name": "xxx",
"sid": "xxx",
"description": "xxx"
},
"parent": null,
"name": "xxx",
"description": "xxx",
"condition": null,
"protocol": {
"name": "xxx",
"sid": "xxx"
},
"redirect_to": null,
"updated_by": "xxx",
"date_updated": "2019-07-04T04:53:09.266604Z",
"date_created": "2019-06-29T19:56:49.495410Z",
"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
Step List

/tables/step/list/{level}/{sid}/{serializer}/
Request
Response
Path Parameters
level
required
string
sid
required
string
serializer
required
string
Headers
token
required
string
Query Parameters
widget__sid
required
string
201: Created
{
"sid": "xxx",
"table": {
"name": "xxx",
"sid": "xxx"
},
"workflow": {
"name": "xxx",
"sid": "xxx",
"description": "xxx"
},
"parent": null,
"name": "xxx",
"description": "xxx",
"condition": null,
"protocol": {
"name": "xxx",
"sid": "xxx"
},
"redirect_to": null,
"updated_by": "xxx",
"date_updated": "2019-07-04T04:53:09.266604Z",
"date_created": "2019-06-29T19:56:49.495410Z",
"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 workflow__sid in get parameters
Wrong workflow sid - the provided workflow sid is not correct

get
Step Detail

/tables/step/detail/{sid}/
Request
Response
Path Parameters
sid
required
string
Headers
token
required
string
200: OK
{
"sid": "xxx",
"table": {
"name": "xxx",
"sid": "xxx"
},
"workflow": {
"name": "xxx",
"sid": "xxx",
"description": "xxx"
},
"parent": null,
"name": "xxx",
"description": "xxx",
"condition": null,
"protocol": {
"name": "xxx",
"sid": "xxx"
},
"redirect_to": null,
"updated_by": "xxx",
"date_updated": "2019-07-04T04:53:09.266604Z",
"date_created": "2019-06-29T19:56:49.495410Z",
"change_permission": true
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
Open to Admin, Manager, Member
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct

patch
Step Detail

/tables/step/detail/{sid}/
Request
Response
Path Parameters
sid
required
string
Headers
token
required
string
200: OK
{
"sid": "xxx",
"table": {
"name": "xxx",
"sid": "xxx"
},
"workflow": {
"name": "xxx",
"sid": "xxx",
"description": "xxx"
},
"parent": null,
"name": "xxx",
"description": "xxx",
"condition": null,
"protocol": {
"name": "xxx",
"sid": "xxx"
},
"redirect_to": null,
"updated_by": "xxx",
"date_updated": "2019-07-04T04:53:09.266604Z",
"date_created": "2019-06-29T19:56:49.495410Z",
"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
Step Detail

/tables/step/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