Data models

Submissions

A submission is created when you submit a workflow through the /workflows endpoint. It contains information about the workflow execution such as the start and end time as well as the current status.

Property	Type	Description
id (required)	string	Unique submission identifier
name (optional)	string	An optional human-readable submission name. The value is derived from the submitted workflow’s name if it has any.
workflow (required)	object	The submitted workflow
priority (optional)	number	A priority used during scheduling. Process chains generated from submissions with higher priorities will be scheduled before those with lower priorities. Negative values are allowed. The value is derived from the submitted workflow but can be overridden. The submission’s priority always takes precedence over the workflow’s priority when generating process chains.
startTime (optional)	string	An ISO 8601 timestamp denoting the date and time when the workflow execution was started. May be `null` if the execution has not started yet.
endTime (optional)	string	An ISO 8601 timestamp denoting the date and time when the workflow execution finished. May be `null` if the execution has not finished yet.
status (required)	string	The current status of the submission
requiredCapabilities (required)	array	A set of strings specifying capabilities a host system must provide to be able to execute this workflow. See also setups.
source (optional)	string	The original, unaltered workflow source as it was submitted through the `/workflows` endpoint. May be `null` if the workflow was not submitted through the endpoint or if the source is unavailable.
runningProcessChains (required)	number	The number of process chains currently being executed
pausedProcessChains (required)	number	The number of process chains whose execution is currently paused
cancelledProcessChains (required)	number	The number of process chains that have been cancelled
succeededProcessChains (required)	number	The number of process chains that have finished successfully
failedProcessChains (required)	number	The number of process chains whose execution has failed
totalProcessChains (required)	number	The current total number of process chains in this submission. May increase during execution when new process chains are generated.
results (optional)	object	If `status` is `SUCCESS` or `PARTIAL_SUCCESS`, this property contains the list of workflow result files grouped by their output variable ID. Otherwise, it is `null`.
errorMessage (optional)	string	If `status` is `ERROR`, this property contains a human-readable error message. Otherwise, it is `null`.

Example

id: aiq7eios7ubxglkcqx5a
workflow:
  api: 4.7.0
  vars:
    - id: myInputFile
      value: /data/input.txt
    - id: myOutputFile
  actions:
    - type: execute
      service: cp
      inputs:
        - id: input_file
          var: myInputFile
      outputs:
        - id: output_file
          var: myOutputFile
          store: true
startTime: '2020-02-13T15:38:58.719382Z'
endTime: '2020-02-13T15:39:00.807715Z'
status: SUCCESS
runningProcessChains: 0
pausedProcessChains: 0
cancelledProcessChains: 0
succeededProcessChains: 1
failedProcessChains: 0
totalProcessChains: 1
results:
  myOutputFile:
    - /data/out/aiq7eios7ubxglkcqx5a/aiq7hygs7ubxglkcrf5a

Submission status

The following table shows the statuses a submission can have:

Status	Description
`ACCEPTED`	The submission has been accepted by Steep but execution has not started yet
`RUNNING`	The submission is currently being executed
`CANCELLED`	The submission was cancelled
`SUCCESS`	The execution of the submission finished successfully
`PARTIAL_SUCCESS`	The submission was executed completely but one or more process chains failed
`ERROR`	The execution of the submission failed

Process chains

Service metadata