Skip to content

jobApproval

Deprecated

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

The new API splits approvals into separate approve and reject endpoints with explicit approval IDs. Use GET /v1/jobs/{jobId}/versions/required-approvals to list pending approvals first.

Open POST /v1/jobs/{jobId}/versions/required-approvals/{requiredApprovalId}/approve in the new API →

View legacy reference

/rest/workflow/job/jobApproval


POST
Approves or Rejects a Job and adds the notes to the Approval/Rejection Job Event (VERAP/VERRE).

Uses JobRef to find the job, if not supplied it will use the jobClientRef and clientId fields to find the job, these are onlt mandatory when the jobRef field hasn't been supplied or is blank.

acceptable request representations:

  • application/json
{
    "jobRef" : "J00YTG",
    "jobClientRef" : "TestJob",
    "clientId" : "1",
    "approvalNotes" : "some notes",
    "approvalStatus" : "1"
}


Notes

  • Approval Status: 1 = Approved, 2 = Rejected.


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.