Skip to content
Honeywick Consulting

resourceObject (output)

Output data sent when one or more stops attached to a resource are modified. Spiral identifies the resource by its id and sends only the attributes that changed — a subset of the input resourceObject. The most commonly updated attributes:

{
"id": <integer>,
"unprod": [stopObject] | null,
"at": <location> | null,
"state": REST | WORK | BRK | STBY | null,
"roster": [dutyKey: time] | null,
"stopOn": <timeInterval> | null,
"skills": [skillObject] | null,
}
id integer
The resource being updated.
unprod stopObject
Updated unproductive stops.
at location
Updated current location.
state REST | WORK | BRK | STBY
Updated operational state.
roster [dutyKey: time]
Updated planned roster.
stopOn timeInterval
Updated stop-on availability.
skills skillObject
Updated skills.

Any other resourceObject attribute (e.g. base, lastOn, lastBreak, currentWorkingLimit, lock, type) may also appear when it changes.

Section titled “Related”