Documentation > Access API > WorkflowController > accessapi/Workflow/Read
accessapi/Workflow/Read
Get a list of all workflows available for this instance.
POST
https://cms.crownpeak.com/[Your Instance]/cpt_webservice/accessapi/Workflow/ReadRequest Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
WorkflowReadResponse
| Name | Description | Type |
|---|---|---|
| ResultCode | eResultCodes | |
| workflows | Dictionary<System.Int32, CrownPeakApp.Model.WorkflowData> | |
| ErrorMessage | System.String | |
| InternalCode | System.Int32 | |
| IsSuccessful | System.Boolean |
Response Formats
application/json
Sample:
{
"workflows": {
"0": {
"id": 0,
"name": "default",
"description": "",
"stepCommands": {},
"modifiedBy": null,
"modifiedDate": "0001-01-01T00:00:00",
"usage": 1050
},
"13": {
"id": 13,
"name": "Short Workflow",
"description": "Simple workflow - draft->live",
"stepCommands": {
"1": {
"stateId": 780,
"subject": "Create a new document",
"description": "",
"commands": [
{
"id": null,
"workflowId": 13,
"workflowStep": 1,
"destinationStatus": 785,
"commandId": 12,
"command": "Publish to Live",
"filterId": 0,
"hasVerifyCommand": false,
"hasRequestComment": false,
"isPublishingStep": false
}
]
},
"2": {
"stateId": 785,
"subject": "Document is live",
"description": "",
"commands": [
{
"id": null,
"workflowId": 13,
"workflowStep": 2,
"destinationStatus": 786,
"commandId": 13,
"command": "Retire",
"filterId": 33,
"hasVerifyCommand": false,
"hasRequestComment": false,
"isPublishingStep": false
},
{
"id": null,
"workflowId": 13,
"workflowStep": 2,
"destinationStatus": 785,
"commandId": 14,
"command": "RePublish to Live",
"filterId": 33,
"hasVerifyCommand": false,
"hasRequestComment": false,
"isPublishingStep": false
}
]
},
"3": {
"stateId": 786,
"subject": "Document is retired",
"description": "",
"commands": [
{
"id": null,
"workflowId": 13,
"workflowStep": 3,
"destinationStatus": 780,
"commandId": 15,
"command": "Revive to Draft",
"filterId": 0,
"hasVerifyCommand": false,
"hasRequestComment": false,
"isPublishingStep": false
}
]
}
},
"modifiedBy": "CrownPeak Admin",
"modifiedDate": "2003-08-27T14:46:13.52",
"usage": 0
},
...
},
"resultCode": "conWS_Success",
"errorMessage": "",
"internalCode": 0
}