Workflow list (schedule of stages)

Parameter	Mandatory	Description	Examples	More Info
API	Yes	The API area	workflow.json
General	Yes	Parameters described in overview	see overview	Structure of an API call
Model Structure	Yes	Name of model required	modelstructure=workflowslist	Using data models
View	No	Stored filter applied		Using views
Filters	No	Filter by a key field		Filters
Company	Yes	The company number	company=1

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/workflow.json?&version=6&job=16/X050028&modelstructure=workflowslist

Example request (legacy username/password):

http://<SERVER>/jsonapi/workflow.json?&version=6&job=16/X050028&modelstructure=workflowslist&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 5,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "synversion": "13.002.0038",
  "synapiversion": 4,
  "data": [
    {
      "stageUuid": "FB4D9A0BC5D72F4E8C89BDA3B0698062",
      "stageTimeStampModified": 1592817013,
      "stageRecordVersionNumber": 20,
      "stageCode": "16/W0000001198",
      "stageDescription": "Coding",
      "stageSequence": 1,
      "stageJobNumber": "16/X050028",
      "stageJobAndPhase": "16/X050028.001"
    }
  ]
}

CSV request:

This call will return the same data as above but as a simple downloaded CSV file

If "modelstructure=view", and a view number also specified, the CSV will contain the columns associated with the view - rather than a standard model

Authorization: Bearer <access_token>
http://&lt;SERVER&gt;/csvapi/workflow.csv?&version=6&job=16/X050028&modelstructure=workflowslist

Example request (legacy username/password):

http://&lt;SERVER&gt;/csvapi/workflow.csv?&version=6&job=16/X050028&modelstructure=workflowslist&user=<username>&password=<password>