Documentation > Access API > WorkflowController > accessapi/Workflow/Read/{id}
accessapi/Workflow/Read/{id}
Get a workflow based on its id from the current instance.
POST
https://cms.crownpeak.com/[Your Instance]/cpt_webservice/accessapi/Workflow/Read/{id}Request Information
URI Parameters
| Name | Description | Type |
|---|---|---|
| id |
Workflow Id |
id |
Body Parameters
None.
Response Information
Resource Description
WorkflowReadByIdResponse
| Name | Description | Type |
|---|---|---|
| ResultCode | eResultCodes | |
| workflow | CrownPeakApp.Model.WorkflowData | |
| ErrorMessage | System.String | |
| InternalCode | System.Int32 | |
| IsSuccessful | System.Boolean |
Response Formats
application/json
Sample:
{
"workflow": {
"id": 10,
"name": "full workflow",
"description": "full workflow",
"stepCommands": {
"1": {
"stateId": 780,
"subject": "Create a new document",
"description": "",
"commands": [
{
"id": null,
"workflowId": 10,
"workflowStep": 1,
"destinationStatus": 781,
"commandId": 1,
"command": "Send for Approval",
"filterId": 0,
"hasVerifyCommand": false,
"hasRequestComment": false,
"isPublishingStep": false
}
]
},
"2": {
"stateId": 782,
"subject": "Rejected",
"description": "",
"commands": []
},
...
},
"modifiedBy": "CrownPeak Admin",
"modifiedDate": "2003-08-27T14:48:45.253",
"usage": 1
},
"resultCode": "conWS_Success",
"errorMessage": "",
"internalCode": 0
}