jobStateChange

Supported, no replacement yet

This endpoint remains fully supported. No replacement exists in the new API yet, and no action is needed. When a replacement ships you will get 12 months' notice, and this site will be updated.

Reference

/rest/workflow/job/jobStateChange

POST

Updates given job ref to given job status. The transitionNotes supplied will be added to the job status move event notes. 

Transitions aren't executed by default so this will update job status on the job WITHOUT moving through different workflow transitions. If a transitionID value is provided the job will have that transition applied

as long as it is a valid transition for the existing job status.

acceptable request representations:

• application/json

{
    "jobRef" : "J00YTG",
    "clientRef" : "",
    "clientId" : "",
    "jobStatusID" : "234",
    "transitionNotes" : "some notes",
    "sor" : "abc,123",
    "jobCost" : "34.23",
    "vat" : "12:23",
    "jobTotal" : "83.23"
    "sigEventCode" : "83.23",
    "transitionID" : "100"   # optional and must be valid for the job status
}

available response representations:

• 200 - application/json

{
  "result" : "success or fail",
  "result_msg" : "error message"
}

See the Workflow API matrix for the full list of endpoints in this category.