ResourceRequirements

Overview

Specifies the combination of the number of Resources that are needed for a Job and the specific Tags (see ResourceRequirementTags) required for each Resource.

System fields

System fields are read-only fields found on most objects. These fields are automatically updated during API operations. To learn more see System Fields.

Standard fields

Field Name Details Required
Description Type
Text

Description
A short description of the Resource Requirement.

Must be between 0 and 255 characters		 No
Duration Type
Duration

Description
The length of time scheduled (in minutes) to complete the Job.		 No
Job Type
Lookup (Jobs)

Description
The Job associated with the Resource Requirement.		 Yes
JobAllocationCount Type
Integer

Description
The count of related Job Allocations without the status of ‘Deleted’.		 Yes
JobAllocationTimeSource Type
Checkbox

Description
Indicates whether or not the ‘start’ and ’end’ times on the Job Allocation take precedence over the Job’s ‘start’ and ’end’ times.		 Yes
JobId Type
ID

Description
The Job associated with the Resource Requirement.		 Yes
Name Type
Text

Description
The generated name of the Resource Requirement. For example, RR-1234.

Must be between 0 and 80 characters		 Yes
Quantity Type
Integer

Description
The number of required Resources.		 Yes
ScheduledEnd Type
DateTime

Description
The timestamp of when the work is scheduled to end.		 No
ScheduledStart Type
DateTime

Description
The timestamp of when the work is scheduled to begin.		 No
Status Type
Picklist

Description
The status of the associated Job.

Valid values are:
- Queued
- Pending Allocation
- Pending Dispatch
- Dispatched
- Ready
- En Route
- On Site
- In Progress
- Complete
- Cancelled		 Yes

This object has the following related objects.

Name Details
JobAllocations Object
Has many (JobAllocations)

Description
The Job Allocations associated with the Resource Requirement.
Tags Object
Has many (ResourceRequirementTags)

Description
The Tags associated with the Resource Requirement.

Deprecated fields

This section lists fields that are marked as deprecated and are maintained for backwards compatibility purposes only. It’s recommended not to use them in new implementations, as they may be removed in future releases.

  • RelativeStart