Allocate Job
Overview
Allocates one or more resources to a job
Category: Allocations
Use this action to allocate one or more resources to a job.
Creates job allocation records linking resources to the job.
The default allocation status is Pending Dispatch.
Request
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
JobId |
string | Yes | The ID of the job to allocate | 0014ccb7-73ad-40e1-9282-2c492a0f313a |
ResourceIds |
array of string | Yes | The IDs of the resources to allocate Min items: 1 |
["00148d32-10ef-4264-adfe-0ff3ece68d92"] |
Status |
string | No | A job allocation status from the JobAllocations.Status picklist Default: Pending Dispatch |
Pending Dispatch |
Response
This action’s output is available as $allocateJob in JSONata expressions. See Response format for the standard result.data / result.errors structure and error handling patterns.
| Field | Type | Description |
|---|---|---|
result.data.uid1, result.data.uid2, … |
string | UIDs of the affected records |
Example output:
{
"uid1": "0014ccb7-73ad-40e1-9282-2c492a0f313a",
"uid2": "00148d32-10ef-4264-adfe-0ff3ece68d92"
}
Feedback
Was this page helpful?