Workflows

Update jobs matching a filter

Update every job matching the query filters, e.g. PATCH /v1/jobs?status=eq.T_PENDING. To update one job, use PATCH /v1/jobs/{jobId}.

status is filterable but not writable here: the lifecycle is a guarded transition graph, so use POST /v1/jobs/{id}/status. Assignments go through POST /v1/jobs/{id}/assignments.

Requires Idempotency-Key header.

patch/v1/jobs

Request

  • Base URL: https://api.workwing.io
  • URL: https://api.workwing.io/v1/jobs
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Unique per write, 1-256 printable ASCII characters. Retrying with the same key and the same request replays the original response for 24 hours. See Idempotency.

Request body

status'T_PENDING' | 'T_SCHEDULED' | 'T_ASSIGNED' | 'T_IN_PROGRESS' | 'T_ON_HOLD' | 'T_INCOMPLETE' | 'T_REBOOK' | 'T_COMPLETED' | 'T_CANCELLED' | 'T_FAILED'

Filterable, not writable here. Sending it answers 409 E_AP_4011; move the lifecycle with POST /v1/jobs/{id}/status.

priority'T_LOW' | 'T_NORMAL' | 'T_HIGH' | 'T_URGENT'
titlestring
notesstring
internal_notesstring

Staff-only notes. Accepted on update but never returned over the API.

scheduled_startstring date-time
scheduled_endstring date-time

Response

Updated job(s)

Changes

No recorded changes to this operation across all 1 revision of this API.