Workflow list
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=workflowdetails | 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:
http://<SERVER>/jsonapi/workflow.json?user=user&password=user&version=4&job=16/X050028&modelstructure=workflowdetails
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 5,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"synversion": "13.010.0057",
"synapiversion": 4.01,
"data": [
{
"stageUuid": "FB4D9A0BC5D72F4E8C89BDA3B0698062",
"stageTimeStampModified": 1592817013,
"stageRecordVersionNumber": 20,
"stageJobOrJobphase": "16/X050028.001",
"stageJobOrJobphaseStatus": 2,
"array_vatcodedescription__workflow_workflowcode": "1 (20%)",
"stageCode": "16/W0000001198",
"stageDescription": "Coding",
"stageSequence": 1,
"stageToStartDate": "2020-06-01",
"stageToEndDate": "2020-06-30",
"stageJobNumber": "16/X050028",
"stageJobAndPhase": "16/X050028.001",
"stageCreatedBy": "U",
"stageCreatedDate": "2019-06-18",
"stageCreatedTime": "10:28:09",
"stageDurationDays": 22,
"stageFinished": true,
"stageFinishedDate": "2020-03-11",
"stageFinishedTime": "17:14:28",
"stageInactive": false,
"stageKeyStep": false,
"stageMilestone": false,
"stageNotes": "",
"stagePercentComplete": 0,
"stageShortNote": "",
"stageToEndTime": "00:00:00",
"stageToStartTime": "00:00:00",
"stageWorkflowType": 466
},