Workflow Definition Reference

A definition for a workflow to be used with the National Infrastructure Modeling Service.

Field	Type	Values	Required	Description
api_version	string	['v1.0.3']	Yes	The version of the API that should be used to process the document.
kind	string	['W']	Yes	The kind of object the document represents. Should equal 'W' for workflows.
metadata	metadata object	-	Yes	The metadata for the Workflow.
spec	spec object	-	Yes	The definition of the workflow to be executed.

metadata

The metadata for the Workflow.

Field	Type	Values	Required	Description
description	string	-	Yes	A rich description of the Workflow's function.
display_name	string	-	Yes	The display name of the Workflow.
name	string	-	Yes	The name that the Workflow should be stored under. This can only contain alphanumeric characters and hyphens.
publisher	string	-	Yes	The name of the person or organisation who has published the Workflow.
summary	string	-	Yes	A short summary of the Workflow's function.
contact_point_name	string	-	Yes	The name of the person to contact for information about the Workflow.
contact_point_email	string	-	Yes	The email of the person to contact for information about the Workflow.
licence	string	-	No	Permanent URL of applicable licence for this Workflow.
rights	string	-	No	Details of any usage rights, restrictions or citations required by users of this Workflow.
subject	string	-	No	Specific area of study or expertise.
project_name	string	-	No	Name or acronym of the workflow's associated project.
project_url	string	-	No	URL of the workflow's associated project.
funding	string	-	No	Funding details of the workflow's associated project.
embargo_end_date	string	-	No	Date when the embargo is lifted for this workflow.

spec

The definition of the workflow to be executed.

Field	Type	Values	Required	Description
steps	steps object	-	Yes	The steps that which Models to run, how to publish/visualise results and any loops to be performed. This is a collection of step uuids mapped to the step definitions.

steps

The steps that which Models to run, how to publish/visualise results and any loops to be performed. This is a collection of step uuids mapped to the step definitions.

Field	Type	Values	Required	Description
step_uuid	step_uuid object	-	No	The key associated with this object 'step_uuid' should be the uuid of the step. If you are using the API to create a Workflow then step uuids should be generated according to UUID v4, if you are manually writing the Workflow to send to the API then https://uuid.me.uk/ can be used to generate uuids. This schema contains the properties that are common between all Workflow steps.

step_uuid

The key associated with this object 'step_uuid' should be the uuid of the step. If you are using the API to create a Workflow then step uuids should be generated according to UUID v4, if you are manually writing the Workflow to send to the API then https://uuid.me.uk/ can be used to generate uuids. This schema contains the properties that are common between all Workflow steps.

Field	Type	Values	Required	Description
name	string	-	Yes	The name used as a reference elsewhere in the definition. This can only container alphanumeric characters and hyphens.
kind	string	['loop', 'model', 'publisher', 'visualisation', 'sweep']	Yes	The kind of step to be run.
dependencies	array of strings	-	Yes	The list of step uuids that this step is dependent on.
position	position object	-	No	The position of the step within the drawflow canva. This field is optional and will be generated for you when viewing the Workflow on the platform if not present.

position

The position of the step within the drawflow canva. This field is optional and will be generated for you when viewing the Workflow on the platform if not present.

Field	Type	Values	Required	Description
x	integer	-	Yes	The x coordinate of the step within the drawflow canvas.
y	integer	-	Yes	The y coordinate of the step within the drawflow canvas.