Skip to content

updateJobV01

Deprecated

This endpoint will stop working on 1 August 2027. Migrate to POST /v1/jobs/{jobId}/version in the new API; the migration guide has the recommended order of work and the important model differences.

Earlier-version updateJob always created a new job version and used a submitVersion flag to choose whether to submit it. In the new API the version creation and submission/approval are separate steps - POST /v1/jobs/{jobId}/version creates the version; approve/reject endpoints submit it.

Open POST /v1/jobs/{jobId}/version in the new API →

View legacy reference

/rest/workflow/job/updateJob

POST
  • Updates a Job.  
  • Can contain multiple job records.  
  • Looks up job by Job Ref if not blank, otherwise by Job Client Ref and Client ID.
  • Updates activities:
    • If activityRef exists updates activity.
    • If activityRef does not exist, adds activity.
    • Removes any other activities.
  • Creates version then chooses to submit version based on submitVersion being set to 0 or 1 (0 = doesnt submit, 1 = submit version)

acceptable request representations:

  • application/json

{    "jobs" : [        {            "jobRef":"",            "jobClientRef":"abc123",
            "clientId":"23",

            "activities": [                {                    "libraryActivityCode" : "5647",                    "activityRef" : "act123",                                        "description" : "optional desc",                    "quantity" : "3"                }            ]
        }    ], "submitVersion" : "1" }


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.