Parameter Set Reference

A Parameter Set defining the parameter values and datasets to use with a Workflow definition to create a Workflow Instance.

Field	Type	Values	Required	Description
api_version	string	['v1.0.0']	Yes	The version of the API that should be used to process the document.
metadata	metadata object	-	Yes	Metadata fields for the Parameter Set.
kind	string	-	Yes	The kind of object the document represents. Should equal 'P' for Parameter Sets.
spec	spec object	-	Yes	A collection of step ids mapped to definitions of the parameter values and datasets to use.

metadata

Metadata fields for the Parameter Set.

Field	Type	Values	Required	Description
display_name	string	-	Yes	The display name of the asset.
name	string	-	Yes	The name used as a reference elsewhere in the definition. This can only container alphanumeric characters and hyphens.
description	string	-	Yes	Description of the Parameter Set.
publisher	string	-	Yes	The name of the person or organisation who has published the Parameter set.
workflow_version	string	-	Yes	UUID of the Workflow Version that this Parameter Set was initially created with.

spec

A collection of step ids mapped to definitions of the parameter values and datasets to use.

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 as it is in the Workflow this Parameter Set is intended to be used with. This schema contains the properties that are common between all Parameter Set steps.

step_uuid

The key associated with this object 'step_uuid' should be the uuid of the step as it is in the Workflow this Parameter Set is intended to be used with. This schema contains the properties that are common between all Parameter Set steps.

Field	Type	Values	Required	Description
kind	string	['model', 'loop', 'sweep']	Yes	The step kind.