Skip to content
Honeywick Consulting

resourceObject

A resource performs work and can service stops based on skills, roster and location. Attribute names and types are links.

{
"id": <integer>,
"type": <resourceParamsKey> | null,
"contract": <contractParamsKey> | null,
"state": REST | WORK | BRK | STBY | CLLD,
"unprod": <stopObject> | null,
"at": <location> | null,
"atTime": <time> | null,
"base": <location> | null,
"roster": [dutyKey: time],
"lastOff": <time> | null,
"lastOn": <time> | null,
"lastBreak": <time> | null,
"stopOn": <timeInterval> | null,
"userId": <integer> | null,
"currentWorkingLimit": <distance> | null,
"lock": <bool>,
"skills": [string: skillObject] | null,
}
id integer
Unique identifier for this resource.
type resourceParamsKey
References a previously defined resource type by key.
contract contractParamsKey
References a previously defined contract by key.
state REST | WORK | BRK | STBY | CLLD
Current operational state: REST (resting), WORK (working), BRK (on break), STBY (standby for callout), CLLD (called-out).
unprod stopObject default null
Additional stops the resource must fulfil (usually directly; can be overridden).
at location
Current position in topography coordinates.
atTime time
The time the current location (at) was last recorded.
base location
The resource’s normal home location.
roster [dutyKey: time]
Planned working roster — a duty key with a start time.
lastOff time
Last end of active work; null if unknown.
lastOn time
Last start of active work; null if unknown.
lastBreak time
Last completion of a break; null if unknown.
stopOn timeInterval
Maximum stop-on time that may be considered after the rostered finish; null is synonymous with 0.
userId integer
Helix-only — user id (sub) that can sign in as this resource in the Engineer view. Add to the resource `ignore` list in the domain so Spiral never sees it.
currentWorkingLimit distance
The resource’s current working-area distance limit (overrides the params soft / hard limits for now).
lock bool default false
Prevents Spiral from rescheduling this resource.
skills [string: skillObject]
The resource’s base skills — a map of skill name → skillObject (not an array).
Section titled “Related”