Workflowslist
Parameter | Type | Description |
---|---|---|
[IN] Parameters described in Overview | ||
Company | String | [IN] The users default company number for the companies list |
Action | String | [IN] Identifier for the list requested |
Resource | String | [IN] Identifier for the resource context |
Workflow [OPTIONAL] | String | [IN] workflow filter parameter |
Job [OPTIONAL] | String | [IN] job filter parameter |
Jobandphase [OPTIONAL] | String | [IN] phase parameter |
Search [OPTIONAL] | String | [IN] search parameter to filter list |
Response | XML/JSON | [OUT] An XML tree / JSON string containing stages the user has access to |
Description
Calling the timesheets API with an action of workflowslist retrieves a list of stages and associated descriptions.
Return Values
Response – List of workflow stages.
The structure of the response is:
<workflows morepages="False" totalpages="1" totalrows="1">
<workflow workflow_uuid="C719C1F7DA8111E2B18D00155D003416">
<workflow_workflowcode>1/00000560.007</workflow_workflowcode>
<workflow_workflowdescription>Client approval</workflow_workflowdescription>
</workflow>
</workflows>
{
"errormessage": "",
"responsecode": 1,
"pagerows": 0,
"totalrows": 1,
"responsestatus": "OK",
"success": true,
"responsemessage": "",
"errorcode": 0,
"totalpages": 1,
"pagenumber": 1,
"data": [
{
"workflow_uuid": "954F1824411CB242AC9358B7BFE227A0",
"workflow_workflowcode": "1/00000560.009",
"workflow_workflowdescription": "Copywriting stage"
}
]
}