Parameters
Section titled “Parameters”None.
Return type
Section titled “Return type”Boolean 4 system Variables are updated
| Name | Value |
|---|---|
| RestHeader | “ClaimJob” |
| RestStatusCode | 200=Ok , 404=NotFound (No data), 401 Unauthorized (cannot login) , 400 Bad Request (Internal error |
| RestStatusText | The Error Message |
| RestBody | The JSON returned with all job properties: {“success”:true,“error_message”:“Job claimed successfully”,“jobId”:15,“runHistoryId”:14,scheduledDate“2026-08-25 12.05.01”,title“abc”… |
Return value
Section titled “Return value”- True if a job was claimed
- False if no job was available.
Behavior
Section titled “Behavior”- If no job is queued,
successisfalseand no other fields are set. - On a successful claim, the job’s status is updated, a corresponding Run History row is created, and that row is linked to the claimed job — so the run’s progress and results can later be tracked back to the originating job.