Data models

Agents

An agent represents an instance of Steep that can execute process chains.

PropertyTypeDescription
id
(required)
stringA unique agent identifier
available
(required)
booleantrue if the agent is currently idle and new process chains can be assigned to it, false if it is busy executing a process chain
capabilities
(required)
arrayA set of strings specifying capabilities the agent provides. See also setups.
startTime
(required)
stringAn ISO 8601 timestamp denoting the date and time when the agent has started.
stateChangedTime
(required)
stringAn ISO 8601 timestamp denoting the date and time when the value of the available property changed from true to false (i.e. when the agent became busy) or from false to true (when it became available)
processChainId
(optional)
stringThe ID of the process chain currently allocated to this agent. May be null if no process chain has been allocated to the agent (i.e. if it is currently available).
Example
id: akuxryerojbw7mnvovaa
available: true
capabilities:
  - docker
startTime: '2020-05-26T10:50:02.001998Z'
stateChangedTime: '2020-05-26T11:06:52.367121Z'