Data: wkfcnf
- Namespace: http://genologics.com/ri/workflowconfiguration
- XML Schema File: wkfcnf.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 workflow
- Type: workflow
The detailed representation of a Workflow.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<wkfcnf:workflow xmlns:wkfcnf="http://genologics.com/ri/workflowconfiguration" name="..." uri="..." status="...">
<protocols>
<protocol name="..." uri="...">
<!--content of type 'protocol-link'-->
</protocol>
<protocol>
<!--(another 'protocol-link' type)-->
</protocol>
<!--...more "protocol" elements...-->
</protocols>
<stages>
<stage name="..." uri="...">
<!--content of type 'stage-link'-->
</stage>
<stage>
<!--(another 'stage-link' type)-->
</stage>
<!--...more "stage" elements...-->
</stages>
</wkfcnf:workflow>
Element workflows
- Type: workflows
The representation of a list of Workflow links.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<wkfcnf:workflows xmlns:wkfcnf="http://genologics.com/ri/workflowconfiguration">
<workflow name="..." uri="..." status="...">
<!--content of type 'workflow-link'-->
</workflow>
<workflow>
<!--(another 'workflow-link' type)-->
</workflow>
<!--...more "workflow" elements...-->
</wkfcnf:workflows>
Type protocol-link
Protocol-link is a child element type of workflow and provides a URI linking to the detailed representation of a protocol.
Attributes
name | type | description |
---|---|---|
name | string |
The name of the Protocol.
Always returns with GET: Yes |
uri | anyURI |
The URI of the Protocol.
Always returns with GET: Yes |
Type stage-link
The detailed representation of a Stage (the portion of a workflow to which samples can be associated in order to be queued)
Attributes
name | type | description |
---|---|---|
name | string | The name of the stage. This is the name of the Protocol Step to which the stage is assigned, except in the case of a QC Protocol where the name of the Protocol is used. |
uri | anyURI |
The URI of the Stage.
Always returns with GET: Yes |
Type status
The workflow status enumeration lists the possible workflow states.
Possible Values
value | description |
---|---|
PENDING | PENDING indicates that the workflow is not ready for use yet. |
ACTIVE | ACTIVE indicates that the workflow may be used. |
ARCHIVED | ARCHIVED indicates that the workflow is no longer in active use. |
Type workflow
The detailed representation of a Workflow.
Attributes
name | type | description |
---|---|---|
name | string |
The name of the Workflow.
Always returns with GET: Yes |
uri | anyURI |
The URI of the Workflow.
Always returns with GET: Yes |
status | status |
The status of the Workflow.
Always returns with GET: Yes |
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
protocols/protocol (protocol-link) | 0/unbounded |
The Protocols that belong to this Workflow.
Always returns with GET: Yes |
stages/stage (stage-link) | 0/unbounded |
The Stages that belong to this Workflow.
Always returns with GET: Yes |
Type workflow-link
Workflow-link is a child element type of workflows and provides a URI linking to the detailed representation of a workflow.
Attributes
name | type | description |
---|---|---|
name | string |
The name of the Workflow.
Always returns with GET: Yes |
uri | anyURI |
The URI of the Workflow.
Always returns with GET: Yes |
status | status |
The status of the Workflow.
Always returns with GET: Yes |
Type workflows
The representation of a list of Workflow links.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
workflow (workflow-link) | 0/unbounded |
The list of Workflows.
Always returns with GET: Yes |