REST API

Data: stp

  • Namespace: http://genologics.com/ri/step
  • XML Schema File: step.xsd

The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.

The following elements are members of this namespace:

The following types are members of this namespace:

Element actions

Example XML

<?xml version="1.0" encoding="UTF-8"?> <stp:actions xmlns:stp="http://genologics.com/ri/step" uri="..."> <step rel="..." uri="..."> <!--content of type 'link'--> </step> <configuration uri="...">...</configuration> <next-actions> <next-action artifact-uri="..." action="..." step-uri="..." rework-step-uri="..."> <!--content of type 'next-action'--> </next-action> <next-action> <!--(another 'next-action' type)--> </next-action> <!--...more "next-action" elements...--> </next-actions> <escalation> <!--content of type 'escalation'--> <request> <!--content of type 'escalation-request'--> <author uri="..."> <!--content of type 'user'--> <first-name> <!--content of type 'string'--> ... </first-name> <last-name> <!--content of type 'string'--> ... </last-name> </author> <reviewer uri="..."> <!--content of type 'user'--> <first-name> <!--content of type 'string'--> ... </first-name> <last-name> <!--content of type 'string'--> ... </last-name> </reviewer> <date> <!--content of type 'dateTime'--> ... </date> <comment> <!--content of type 'string'--> ... </comment> </request> <review> <!--content of type 'escalation-review'--> <author uri="..."> <!--content of type 'user'--> <first-name> <!--content of type 'string'--> ... </first-name> <last-name> <!--content of type 'string'--> ... </last-name> </author> <date> <!--content of type 'dateTime'--> ... </date> <comment> <!--content of type 'string'--> ... </comment> </review> <escalated-artifacts> <escalated-artifact uri="..."> <!--content of type 'escalated-artifact'--> </escalated-artifact> <escalated-artifact> <!--(another 'escalated-artifact' type)--> </escalated-artifact> <!--...more "escalated-artifact" elements...--> </escalated-artifacts> </escalation> </stp:actions>

Element details

Example XML

<?xml version="1.0" encoding="UTF-8"?> <stp:details xmlns:stp="http://genologics.com/ri/step" uri="..."> <step rel="..." uri="..."> <!--content of type 'link'--> </step> <configuration uri="...">...</configuration> <input-output-maps> <input-output-map> <!--content of type 'input-output-map'--> <input limsid="..." type="..." output-generation-type="..." uri="..."> <!--content of type 'artifact'--> </input> <output limsid="..." type="..." output-generation-type="..." uri="..."> <!--content of type 'artifact'--> </output> </input-output-map> <input-output-map> <!--(another 'input-output-map' type)--> </input-output-map> <!--...more "input-output-map" elements...--> </input-output-maps> <udf:fields xmlns:udf="http://genologics.com/ri/userdefined"> <udf:field unit="..." name="..." type="...">...</udf:field> <udf:field> <!--(another 'field' type)--> </udf:field> <!--...more "field" elements...--> </udf:fields> <preset> <!--content of type 'string'--> ... </preset> <instrument uri="...">...</instrument> </stp:details>

Element lots

The list representation of a step's reagent lots.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <stp:lots xmlns:stp="http://genologics.com/ri/step" uri="..."> <step rel="..." uri="..."> <!--content of type 'link'--> </step> <configuration uri="...">...</configuration> <reagent-lots> <reagent-lot uri="..." limsid="..."> <!--content of type 'reagent-lot-link'--> </reagent-lot> <reagent-lot> <!--(another 'reagent-lot-link' type)--> </reagent-lot> <!--...more "reagent-lot" elements...--> </reagent-lots> </stp:lots>

Element placements

The detailed representation of a step's output artifact container placements

Example XML

<?xml version="1.0" encoding="UTF-8"?> <stp:placements xmlns:stp="http://genologics.com/ri/step" uri="..."> <step rel="..." uri="..."> <!--content of type 'link'--> </step> <configuration uri="...">...</configuration> <selected-containers> <container uri="..."> <!--content of type 'container'--> </container> <container> <!--(another 'container' type)--> </container> <!--...more "container" elements...--> </selected-containers> <output-placements> <output-placement uri="..."> <!--content of type 'output-placement'--> <location> <!--content of type 'location'--> <container limsid="..." uri="..."> <!--content of type 'container'--> </container> <value> <!--content of type 'string'--> ... </value> </location> </output-placement> <output-placement> <!--(another 'output-placement' type)--> </output-placement> <!--...more "output-placement" elements...--> </output-placements> </stp:placements>

Element pools

The detailed representation of a step's pooled inputs.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <stp:pools xmlns:stp="http://genologics.com/ri/step" uri="..."> <step rel="..." uri="..."> <!--content of type 'link'--> </step> <configuration uri="...">...</configuration> <pooled-inputs> <pool name="..." output-uri="..."> <!--content of type 'pooled-inputs'--> <input uri="..." replicates="..."> <!--content of type 'input'--> </input> <input> <!--(another 'input' type)--> </input> <!--...more "input" elements...--> </pool> <pool> <!--(another 'pooled-inputs' type)--> </pool> <!--...more "pool" elements...--> </pooled-inputs> <available-inputs> <input uri="..." replicates="..."> <!--content of type 'input'--> </input> <input> <!--(another 'input' type)--> </input> <!--...more "input" elements...--> </available-inputs> </stp:pools>

Element program-status

The current EPP status for a step (supports automatically triggered programs only).

Example XML

<?xml version="1.0" encoding="UTF-8"?> <stp:program-status xmlns:stp="http://genologics.com/ri/step" uri="..."> <step rel="..." uri="..."> <!--content of type 'link'--> </step> <configuration uri="...">...</configuration> <status> <!--content of type 'status'--> ... </status> <message> <!--content of type 'string'--> ... </message> </stp:program-status>

Element reagents

The detailed representation of a step's output artifact reagents.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <stp:reagents xmlns:stp="http://genologics.com/ri/step" uri="..."> <step rel="..." uri="..."> <!--content of type 'link'--> </step> <configuration uri="...">...</configuration> <reagent-category> <!--content of type 'string'--> ... </reagent-category> <output-reagents> <output uri="..."> <!--content of type 'output'--> <reagent-label name="..."> <!--content of type 'reagent-label'--> </reagent-label> <reagent-label> <!--(another 'reagent-label' type)--> </reagent-label> <!--...more "reagent-label" elements...--> </output> <output> <!--(another 'output' type)--> </output> <!--...more "output" elements...--> </output-reagents> </stp:reagents>

Element setup

Example XML

<?xml version="1.0" encoding="UTF-8"?> <stp:setup xmlns:stp="http://genologics.com/ri/step" uri="..."> <step rel="..." uri="..."> <!--content of type 'link'--> </step> <configuration uri="...">...</configuration> <files> <file shared-result-file-index="..." artifact-uri="..." limsid="..." name="..."> <!--content of type 'file'--> <message> <!--content of type 'string'--> ... </message> </file> <file> <!--(another 'file' type)--> </file> <!--...more "file" elements...--> </files> </stp:setup>

Element step

The detailed representation of a step.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <stp:step xmlns:stp="http://genologics.com/ri/step" uri="..." limsid="..." current-state="..."> <configuration uri="...">...</configuration> <date-started> <!--content of type 'dateTime'--> ... </date-started> <date-completed> <!--content of type 'dateTime'--> ... </date-completed> <actions uri="..."> <!--content of type 'actions-link'--> </actions> <reagents uri="..."> <!--content of type 'reagents-link'--> </reagents> <pools uri="..."> <!--content of type 'pools-link'--> </pools> <placements uri="..."> <!--content of type 'placements-link'--> </placements> <reagent-lots uri="..."> <!--content of type 'reagent-lots-link'--> </reagent-lots> <program-status uri="..."> <!--content of type 'program-status-link'--> </program-status> <setup uri="..."> <!--content of type 'setup-link'--> </setup> <details uri="..."> <!--content of type 'details-link'--> </details> <available-programs> <available-program uri="..." name="..."> <!--content of type 'available-program'--> </available-program> <available-program> <!--(another 'available-program' type)--> </available-program> <!--...more "available-program" elements...--> </available-programs> <automatic-next-step uri="..."> <!--content of type 'automatic-next-step-link'--> </automatic-next-step> </stp:step>

Element step-creation

A request to create a step.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <stp:step-creation xmlns:stp="http://genologics.com/ri/step"> <configuration uri="...">...</configuration> <container-type> <!--content of type 'string'--> ... </container-type> <reagent-category> <!--content of type 'string'--> ... </reagent-category> <inputs> <input uri="..." control-type-uri="..." replicates="..."> <!--content of type 'creation-input'--> </input> <input> <!--(another 'creation-input' type)--> </input> <!--...more "input" elements...--> </inputs> </stp:step-creation>

Type actions

Attributes

name type description
uri anyURI (no documentation provided)

Child Elements

name (type) min/max
occurs		 description
step (link) 0/1 The step (process).
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No
configuration (step-configuration) 0/1 The protocol step configuration.
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No
next-actions/next-action (next-action) 0/unbounded All samples belong to one step; these samples can move forward for another configured step work or need special handling, such as remove from the workflow they are in, leave in their existing queue for rework, or require view by a manager, etc...
escalation (escalation) 0/1 The escalation details. When a step is under or completed review, escalation details include information on who requested the escalation, who attended to it and what samples were escalated.
Always returns with GET: No (only available if set)
Updatable with PUT: Yes
Required for PUT: No (omitting means clearing the escalation details)

Type actions-link

Identifies the resource that represents the actions applied or to be applied by the step.

Attributes

name type description
uri anyURI The URI of corresponding step actions resource.

Type action-type

Special actions for samples.

Possible Values

value description
leave Leave the sample in the QC protocol.
repeat Repeat this step.
remove Remove from workflow.
review Request manager review.
complete Mark protocol as complete.
store Store for later.
nextstep Continue to the next step.
rework Rework from an earlier step.
completerepeat Complete and Repeat
unknown The action is unknown.

Type artifact

Artifact is a child element of input-output-map and provides a link to an Artifact that was either an input or output of the Step for the input-output-map.

Attributes

name type description
limsid string The LIMS ID of the artifact.
Always returns with GET: Yes
type string The type of the Artifact.
Always returns with GET: No
output-generation-type output-generation-type Specifies how the outputs were generated in relation to the inputs.
Always returns with GET: Yes
uri anyURI The URI of the artifact.
Always returns with GET: Yes

Type automatic-next-step-link

Identifies the resource that represents the step that was automatically begun when the "Automatically start Next Step" option is enabled in a step's configuration.

Attributes

name type description
uri anyURI The URI of the corresponding step resource.

Type available-program

Identifies a program that is available for a step.

Attributes

name type description
uri anyURI The URI to execute the program for this step (via POST, with no request entity).
name string The name of the program to execute. Matches the trigger name ('name' attribute in the 'epp-trigger' element) in the protocol step configuration.

Type container

Provides a URI linking to a selected container to be used for placement.

Attributes

name type description
uri anyURI The URI of the container.
Always returns with GET: Yes
Creatable with POST: No
Required for POST: Yes

Type creation-input

Typically, provides a URI linking to the input artifact. Can also be used to designate control sample inputs (via its control type). One of 'uri' or 'control-type-uri' attributes must be provided, but not both.

Attributes

name type description
uri anyURI The URI of the input artifact.
Required for POST: Yes (if the input denotes a regular artifact)
control-type-uri anyURI The URI of the control type to use.
Required for POST: Yes (if the input denotes a control)
replicates long The number of replicates to generate for the input.
Required for POST: No; If not specified, defaults to 1.

Type details

Attributes

name type description
uri anyURI The URI of the Step Details.
Always returns with GET: Yes

Child Elements

name (type) min/max
occurs		 description
step (link) 0/1 The step (process).
Always returns with GET: Yes
configuration (step-configuration) 0/1 The protocol step configuration.
Always returns with GET: Yes
input-output-maps/input-output-map (input-output-map) 0/unbounded Each input-output-map relates one of the step inputs to one of the outputs that was produced for that input. There will be a distinct input-output-map for each pairing of step input to step output.
Always returns with GET: Yes
fields/field (field) 0/unbounded The user-defined fields of this Step.
Always returns with GET: No
Updatable with PUT: Yes
Required for PUT: No, unless UDFs have been configured as required.
preset (string) 0/1 The preset name used for the step.
Always returns with GET: No
Updatable with PUT: Yes
Required for PUT: No, if not provided, an existing preset selection will be cleared
instrument (instrument) 0/1 Instrument provides a URI linking to the detailed representation of the instrument for the step.
Always returns with GET: No
Updatable with PUT: Yes
Required for PUT: No, if not provided, an existing instrument selection will be cleared

Type details-link

Identifies the resource that represents the details for the step.

Attributes

name type description
uri anyURI The URI of corresponding step details resource.

Type escalated-artifact

Sample next action or step.

Attributes

name type description
uri anyURI The URI of the artifact.
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No

Type escalation

Escalation details.

Child Elements

name (type) min/max
occurs		 description
request (escalation-request) 0/1 The escalation request details.
Always returns with GET: Yes
Updatable with PUT: Yes
Required for PUT: Yes
review (escalation-review) 0/1 The review details. Only available after review is completed.
Always returns with GET: No
Updatable with PUT: No
Required for PUT: No
escalated-artifacts/escalated-artifact (escalated-artifact) 0/unbounded All samples marked for escalation.

Type escalation-request

Child Elements

name (type) min/max
occurs		 description
author (user) 0/1 The user that originated the escalation.
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No
reviewer (user) 0/1 The reviewer originally requested to review samples.
Always returns with GET: Yes
Updatable with PUT: Yes
Required for PUT: Yes
date (dateTime) 0/1 The time the escalation occurred.
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No
comment (string) 0/1 The comment entered by the user escalating the step.
Always returns with GET: Yes
Updatable with PUT: Yes
Required for PUT: Yes

Type escalation-review

Child Elements

name (type) min/max
occurs		 description
author (user) 0/1 The user that actually reviewed the step.
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No
date (dateTime) 0/1 The time the reviewer completed the step.
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No
comment (string) 0/1 The comment entered by the user reviewing the step.
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No

Type file

The file element describes a shared result file output that will be displayed in the step-setup view.

Attributes

name type description
shared-result-file-index string The shared result file output index of the step output.
Always returns with GET: Yes
artifact-uri anyURI The URI of the artifact.
Always returns with GET: Yes
limsid string The LIMS ID of the artifact.
Always returns with GET: Yes
name string The name of the file.
Always returns with GET: Yes

Child Elements

name (type) min/max
occurs		 description
message (string) 0/1 The message to display for this shared result file in the step-setup view.
Always returns with GET: Yes

Type input

Provides input URI links.

Attributes

name type description
uri anyURI The URI of the artifact.
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: Yes
replicates long The number of available replicates for pooling.
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No

Type input-output-map

Input-output-map is a child element of Step and relates one of the Step inputs to one of the outputs that was produced for that input.

There will be a distinct input-output-map for each pairing of Step input to Step output. If an input is not mapped to any outputs, the input will be listed with no outputs.

Child Elements

name (type) min/max
occurs		 description
input (artifact) 0/1 Input provides a URI linking to the input Artifact for the input-output-map.
Always returns with GET: Yes
output (artifact) 0/1 Output provides a URI linking to the output Artifact for the input-output-map.
Always returns with GET: No

Type instrument

The instrument element provides a URI to the selected instrument for the step.

Attributes

name type description
uri anyURI The URI of the instrument.
Always returns with GET: Yes

Value

  • Type: string

The name of the instrument.
Always returns with GET: Yes

Type next-action

Sample next action or step.

Attributes

name type description
artifact-uri anyURI The URI of the artifact.
Always returns with GET: Yes
Updatable with PUT: no
Required for PUT: yes
action action-type The next action for the sample.
Always returns with GET: no; the sample may not have a next action.
Updatable with PUT: yes
Required for PUT. If the action is not present during an update, the existing action for the sample will be removed if there is one.
step-uri anyURI The next protocol step for the sample.
Always returns with GET: no; the sample may not have a next step.
Updatable with PUT: yes
Required for PUT. If the step is not present during an update, the existing step for the sample will be removed if there is one.
rework-step-uri anyURI The rework step instance uri (ie http://severname:8080/api/v2/steps/{ID}) for the sample.
Always returns with GET: no; the sample may not have a rework step
Updatable with PUT: yes
Required for PUT. If the rework step is not present during an update, the existing rework step for the sample will be removed if there is one.

Type output

Provides a URI linking to the output artifact and reagent label.

Attributes

name type description
uri anyURI The URI of the artifact.
Always returns with GET: Yes
Creatable with POST: No
Required for POST: Yes

Child Elements

name (type) min/max
occurs		 description
reagent-label (reagent-label) 0/unbounded The reagent labels for the artifact.
Always returns with GET: No; the artifact may not have reagent labels.
Creatable with POST: Yes
Required for POST: No; If specified, an existing reagent label will be replaced with the new label. If not specified, existing labels will be removed.

Type output-generation-type

The available options for output-type generation.

Possible Values

value description
PerInput Output applies to individual inputs
PerAllInputs Output applies to all inputs
PerReagentLabel Output applies to inputs per reagent label

Type output-placement

Provides a URI linking to the output artifact and container placement.

Attributes

name type description
uri anyURI The URI of the artifact.
Always returns with GET: Yes
Creatable with POST: No
Required for POST: Yes

Child Elements

name (type) min/max
occurs		 description
location (location) 0/1 The container placement for the artifact.
Always returns with GET: No; the artifact may not have a placement.
Creatable with POST: Yes
Required for POST: No; If specified, any existing placement will be replaced with the new placement. If not specified, any existing placement will be removed.

Type placements

The detailed representation of a step's output artifact container placements

Attributes

name type description
uri anyURI The URI of the StepPlacements.
Always returns with GET: Yes
Creatable with POST: No
Required for POST: No

Child Elements

name (type) min/max
occurs		 description
step (link) 0/1 The protocol step of the StepPlacements.
Always returns with GET: Yes
Creatable with POST: No
Required for POST: No
configuration (step-configuration) 0/1 The protocol step configuration.
Always returns with GET: Yes
Creatable with POST: No
Required for POST: No
selected-containers/container (container) 0/unbounded The selected containers for step placement.
Always returns with GET: Yes
Creatable with POST: Yes
Required for POST: No
output-placements/output-placement (output-placement) 0/unbounded The output artifacts for this step with placement if they have one.
Always returns with GET: Yes
Creatable with POST: Yes
Required for POST: No

Type placements-link

Identifies the resource that represents the output placements for the step.

Attributes

name type description
uri anyURI The URI of corresponding step placements resource.

Type pooled-inputs

Provides pooled input groups.

Attributes

name type description
name string The pool name.
Always returns with GET: Yes
Updatable with PUT: Yes
Required for PUT: Yes
output-uri anyURI The URI of the pooled output artifact.
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No

Child Elements

name (type) min/max
occurs		 description
input (input) 0/unbounded The pooled input artifacts for this pool.
Always returns with GET: Yes
Updatable with PUT: Yes
Required for PUT: Yes

Type pools

The detailed representation of a step's pooled inputs.

Attributes

name type description
uri anyURI The URI of the StepPools.
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No

Child Elements

name (type) min/max
occurs		 description
step (link) 0/1 The step (process).
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No
configuration (step-configuration) 0/1 The protocol step configuration.
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No
pooled-inputs/pool (pooled-inputs) 0/unbounded The pooled input artifacts for this step.
Always returns with GET: Yes
Updatable with PUT: Yes
Required for PUT: No
available-inputs/input (input) 0/unbounded The available input artifacts for this step.
Always returns with GET: Yes

Type pools-link

Identifies the resource that represents the pools added by the step.

Attributes

name type description
uri anyURI The URI of corresponding step pools resource.

Type program-status

The current EPP status for a step (supports automatically triggered programs only).

Attributes

name type description
uri anyURI The URI to this status.

Child Elements

name (type) min/max
occurs		 description
step (link) 0/1 The step (process).
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No
configuration (step-configuration) 0/1 The protocol step configuration.
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No
status (status) 0/1 The nature of the status.
message (string) 0/1 The user-facing message for this status.

Type program-status-link

Identifies the resource that represents the program status for the step.

Attributes

name type description
uri anyURI The URI of corresponding step program status resource.

Type reagent-label

Reagent-label is a child element of ExtStepReagentListElement and provides the name of a label or reagent that has been added to the Artifact.

Attributes

name type description
name string The reagent label name for the artifact.
Always returns with GET: No; the artifact may not have a reagent label.
Creatable with POST: Yes
Required for POST: No; If specified, an existing reagent label will be replaced with the new label. If not specified, existing labels will be removed.

Type reagent-lot-link

Provides a URI linking to the reagent lot details.

Attributes

name type description
uri anyURI The URI of the reagent lot.
limsid string The limsid of the reagent lot.

Type reagent-lots-link

Identifies the resource that represents the reagent lots for the step.

Attributes

name type description
uri anyURI The URI of the corresponding reagent lots resource.

Type reagents

The detailed representation of a step's output artifact reagents.

Attributes

name type description
uri anyURI The URI of the StepReagents.
Always returns with GET: Yes
Creatable with POST: No
Required for POST: No

Child Elements

name (type) min/max
occurs		 description
step (link) 0/1 The step (process).
Always returns with GET: Yes
Creatable with POST: No
Required for POST: No
configuration (step-configuration) 0/1 The protocol step configuration.
Always returns with GET: Yes
Creatable with POST: No
Required for POST: No
reagent-category (string) 0/1 The permitted reagent category of the step. Reagent labels used in the POST must be from this reagent category.
Always returns with GET: Yes
Creatable with POST: No
Required for POST: No
output-reagents/output (output) 0/unbounded The output artifacts for this step.
Always returns with GET: Yes

Type reagents-link

Identifies the resource that represents the reagents added by the step.

Attributes

name type description
uri anyURI The URI of corresponding step reagents resource.

Type reagents-lots

The list representation of a step's reagent lots.

Attributes

name type description
uri anyURI The URI of the StepReagentLots.

Child Elements

name (type) min/max
occurs		 description
step (link) 0/1 The step (process).
configuration (step-configuration) 0/1 The protocol step configuration.
reagent-lots/reagent-lot (reagent-lot-link) 0/unbounded The reagent lots for this step.

Type setup

Attributes

name type description
uri anyURI The URI of the Step Setup.
Always returns with GET: Yes

Child Elements

name (type) min/max
occurs		 description
step (link) 0/1 The step (process).
Always returns with GET: Yes
configuration (step-configuration) 0/1 The protocol step configuration.
Always returns with GET: Yes
files/file (file) 0/unbounded Collection of shared result file outputs.

Type setup-link

Identifies the resource that represents the setup for the step.

Attributes

name type description
uri anyURI The URI of corresponding step setup resource.

Type status

Describes the different natures of status for an external program.

Possible Values

value description
OK The program finished successfully.
ERROR The program failed to run or failed when executing.
WARNING The program finished successfully but generated a warning message.
RUNNING A program is currently in progress. This status cannot be set, only read.
QUEUED A program is currently waiting for an available External Program Node to run on.

Type step

The detailed representation of a step.

Attributes

name type description
uri anyURI (no documentation provided)
limsid string The LIMS ID of the Step/Process.
current-state string The current state of the step

Child Elements

name (type) min/max
occurs		 description
configuration (step-configuration) 0/1 The configuration information for the step run.
date-started (dateTime) 0/1 The started date of the step, in yyyy-MM-dd'T'HH:mm:ss.SSSXXX format.
Always returns with GET: Yes
date-completed (dateTime) 0/1 The completed date of the step, in yyyy-MM-dd'T'HH:mm:ss.SSSXXX format.
Always returns with GET: No, if the step has not completed, the date-completed will not show.
actions (actions-link) 0/1 The corresponding step actions.
reagents (reagents-link) 0/1 The corresponding step reagents.
pools (pools-link) 0/1 The corresponding step pools.
placements (placements-link) 0/1 The corresponding step placements.
reagent-lots (reagent-lots-link) 0/1 The corresponding reagent lots for the step.
program-status (program-status-link) 0/1 The corresponding step program status, if one exists.
setup (setup-link) 0/1 The corresponding step setup.
details (details-link) 0/1 The corresponding step details.
available-programs/available-program (available-program) 0/unbounded The programs available for direct triggering on the step.
automatic-next-step (automatic-next-step-link) 0/1 The corresponding step that was automatically begun when the "Automatically start Next Step" option is enabled in the step's configuration.

Type step-configuration

Identifies the configuration information for the step run.

Attributes

name type description
uri anyURI The URI of the protocol step.

Value

  • Type: string

(no documentation provided)

Type step-creation

A request to create a step.

Child Elements

name (type) min/max
occurs		 description
configuration (step-configuration) 0/1 The protocol step configuration.
container-type (string) 0/1 The name of the container type to create an initial on-the-fly container for placing outputs in.
Required for POST: Yes if the process has placeable outputs
reagent-category (string) 0/1 The name of the reagent category to use for the step.
Required for POST: Yes for any reagent addition steps
inputs/input (creation-input) 0/unbounded The inputs to the process.
Required for POST: Yes

Type user

Describes a user as required in the context of step escalations.

Attributes

name type description
uri anyURI The URI of the user.
Always returns with GET: Yes
Updatable with PUT: Yes
Required for PUT: Yes

Child Elements

name (type) min/max
occurs		 description
first-name (string) 0/1 The first name of the user.
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No
last-name (string) 0/1 The last name of the user.
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No

Home

REST Endpoints

XML Data Elements

XML Data Types

© Copyright 2020 GenoLogics Life Sciences Software, An Illumina Company.
Generated by Enunciate. Template design by Arcsin.