Provides access to thestate store. In particular jobs can be created, queried and have metadata attached.
Adds a new job link to a job
The destination job to link to
The subtype for this link
Any additional metadata for this link
Optionally the job to create the link on, defaults to @see busby.root.job
Update Job Info Options
The result of adding the job link
Adds a new state info to the current state change
The info type for the state info to add
The sub type of the state info to add
The content of the state info
(DEPRECATED!) Adds a new state info to a specific state change instance
The info type for the state info to add
The sub type of the state info to add
The content of the state info
The Job or StateInstance to add the state info against
Additional state store options
A result
Gets the latest job link of a specific type. Note: if there are multiple links of the same subtype @see getJobLinksByType
The subtype to get
Optionally the job to get the links from
The latest Job Link of subType
Get a list of job links for a specific type
The subtype of the job link to get
Optionally the job to get the subtypes from
An array of job link instances
Gets jobs in a workflow in a specific state or states.
The state uuid(s) to get
The workflow name that the state is in
Add Job Info options, for example state info blocks
The result of the start step
Gets jobs in a workflow in a specific state or states.
The state id(s) to get
The workflow name that the state is in
Add Job Info options, for example state info blocks
The result of the start step
Gets the latest info block instance for a specific info type and sub type
The job check
The info type to find
The subtype to find
The latest info instance for the info type and sub type pair
Gets the latest info block instance for a specific info uuid
The job to check
The info uuid to find
The latest info instance with info uuid
Gets the latest info block instance for a specific sub type
The job check
The subtype to find
The latest info instance for the sub type
Gets a unique serial number
the prefix of the serial number to be generated
Gets a state definition
Gets a state definition by id
The state id
The name of the workflow
additoinal state store options
a state definition
Gets a state definition by state display name
The state displayname
The name of the workflow
additoinal state store options
a state definition
Gets the workflow
The workflow, if null returns the current script step workflow
Recursively merges properties of the new info block into the existing info block, skipping new info block properties that resolve to undefined. Array and plain object properties are merged recursively. Other objects and value types are overridden by assignment. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources.
The info type to merge
The sub type to merge
The info to merge
Optionally which job to merge in
State store options
Recursively merges properties of the new json info block into the existing json info block, skipping new json info block properties that resolve to undefined. Array and plain object properties are merged recursively. Other objects and value types are overridden by assignment. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources.
The sub type to merge
The json info block
Optionally which job to merge in
State store options
Change the should change by value ofthisjob
The new time to change by as a string in ISO8601 format
Change the should change by value ofthisjob
The new time to change by using a luxon DateTime object
Change the should change by value ofthisjob
The new time to change by using a moment string
Moves a job along in the workflow to a specific state.
The uuid of the job to perform a start step
The state name to startstep into
The workflow name that the state is in
Add Job Info options, for example state info blocks and should change by
The result of the start step
Moves a job along in the workflow to a specific state.
The uuid of the job to perform a start step
The state name to startstep into
The workflow name that the state is in
The time it should change out of the state you are moving it to
Add Job Info options, for example state info blocks
The result of the start step
Moves a job along in the workflow to a specific state.
The uuid of the job to perform a start step
The state name to startstep into
The workflow name that the state is in
The time it should change out of the state you are moving it to
Add Job Info options, for example state info blocks
The result of the start step
Moves a job along in the workflow to a specific state.
The uuid of the job to perform a start step
The state id to startstep into
The workflow name that the state is in
Add Job Info options, for example state info blocks and should change by
The result of the start step
Moves a job along in the workflow to a specific state.
The uuid of the job to perform a start step
The state id to startstep into
The workflow name that the state is in
The time it should change out of the state you are moving it to
Add Job Info options, for example state info blocks
The result of the start step
Moves a job along in the workflow to a specific state.
The uuid of the job to perform a start step
The state id to startstep into
The workflow name that the state is in
The time it should change out of the state you are moving it to
Add Job Info options, for example state info blocks
The result of the start step
Replaces the info block contents with the new content.
The info type to update
The sub type to update
The content
Optionally which job to merge in
Optionally some additional options