Workflow details (stage)

Workflow list

Workflow details (stage)

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaworkflow.json
GeneralYesParameters described in overviewsee overviewStructure of an API call
Model StructureYesName of model requiredmodelstructure=workflowdetailsUsing data models
ViewNoStored filter appliedUsing views
FiltersNoFilter by a key fieldFilters
CompanyYesThe company numbercompany=1

Example request (OAuth 2.0):

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

Example request (legacy username/password):

http://<SERVER>/jsonapi/workflow.json?&version=6&job=16/X050028&modelstructure=workflowdetails&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.010.0057",
  "synapiversion": 4.01,
  "data": [
    {
      "stageUuid": "FB4D9A0BC5D72F4E8C89BDA3B0698062",
      "stageTimeStampModified": 1592817013,
      "stageRecordVersionNumber": 20,
      "stageJobOrJobphase": "16/X050028.001",
      "stageJobOrJobphaseStatus": 2,
      "stageTaxCodeDescription": "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
    }
  ]
}