Skip to content

updateDescription

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.

No calls to this endpoint were recorded in production access logs (April to June 2026), so it may be retired ahead of the standard date. If your integration still uses it, contact Oneserve support as soon as possible so that it stays supported until the standard retirement date.

Legacy let you update a job's description (with appendDescription flag) preferably without creating a new version. The new API has no description-only update path - changes go via the standard versioning flow, which always creates a new job version. No "append vs replace" toggle in the new API.

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

View legacy reference

/rest/workflow/job/updateJobDescription

POST
  • Updates a Job Description 
  • Can contain multiple job records.
  • Looks up job by Job Ref if not blank, otherwise by Job Client Ref and Client ID.
  • Contains the option to replace or append the description -
    • appendDescription = 0, then replace whole description with new description
    • appendDescription = 1, then add description text to end of current description
  • Prefereably done without creating a new job Version.
acceptable request representations:

  • application/json

{
  "jobs" : [
    {
      "jobRef":"",
      "jobClientRef":"abc123",
      "clientId":"23",
      "appendDescription":"0",
      "description":"A new Description"
    }
  ]
}


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.