Data: protcnf
- Namespace: http://genologics.com/ri/protocolconfiguration
- XML Schema File: protcnf.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 protocol
- Type: protocol
Detailed representation of a protocol.
A protocol represents a collection of different steps.
A protocol can be a QC protocol meaning samples go through the process
mostly in parallel or a normal protocol, where samples go
through in series.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<protcnf:protocol xmlns:protcnf="http://genologics.com/ri/protocolconfiguration" name="..." index="..." uri="...">
<steps>
<step name="..." uri="..." protocol-uri="...">
<!--content of type 'step'-->
<protocol-step-index>
<!--content of type 'int'-->
...
</protocol-step-index>
<process-type uri="...">...</process-type>
<permitted-containers>
<container-type>
<!--content of type 'string'-->
...
</container-type>
<container-type>
<!--(another 'string' type)-->
</container-type>
<!--...more "container-type" elements...-->
</permitted-containers>
<permitted-reagent-categories>
<reagent-category>
<!--content of type 'string'-->
...
</reagent-category>
<reagent-category>
<!--(another 'string' type)-->
</reagent-category>
<!--...more "reagent-category" elements...-->
</permitted-reagent-categories>
<required-reagent-kits>
<reagent-kit name="..." uri="...">
<!--content of type 'reagent-kit-link'-->
</reagent-kit>
<reagent-kit>
<!--(another 'reagent-kit-link' type)-->
</reagent-kit>
<!--...more "reagent-kit" elements...-->
</required-reagent-kits>
<permitted-control-types>
<control-type name="..." uri="...">
<!--content of type 'control-type-link'-->
</control-type>
<control-type>
<!--(another 'control-type-link' type)-->
</control-type>
<!--...more "control-type" elements...-->
</permitted-control-types>
<transitions>
<transition name="..." sequence="..." next-step-uri="...">
<!--content of type 'next-step'-->
</transition>
<transition>
<!--(another 'next-step' type)-->
</transition>
<!--...more "transition" elements...-->
</transitions>
<default-grouping>
<!--content of type 'string'-->
...
</default-grouping>
<queue-fields>
<queue-field detail="..." name="..." attach-to="...">
<!--content of type 'queuefield'-->
</queue-field>
<queue-field>
<!--(another 'queuefield' type)-->
</queue-field>
<!--...more "queue-field" elements...-->
</queue-fields>
<step-fields>
<step-field name="..." attach-to="...">
<!--content of type 'field'-->
</step-field>
<step-field>
<!--(another 'field' type)-->
</step-field>
<!--...more "step-field" elements...-->
</step-fields>
<sample-fields>
<sample-field name="..." attach-to="...">
<!--content of type 'field'-->
</sample-field>
<sample-field>
<!--(another 'field' type)-->
</sample-field>
<!--...more "sample-field" elements...-->
</sample-fields>
<step-properties>
<step-property name="..." value="...">
<!--content of type 'step-property'-->
</step-property>
<step-property>
<!--(another 'step-property' type)-->
</step-property>
<!--...more "step-property" elements...-->
</step-properties>
<step-setup>
<!--content of type 'step-setup'-->
<files>
<file shared-result-file-index="...">
<!--content of type 'file'-->
<message>
<!--content of type 'string'-->
...
</message>
</file>
<file>
<!--(another 'file' type)-->
</file>
<!--...more "file" elements...-->
</files>
</step-setup>
<epp-triggers>
<epp-trigger name="..." type="..." point="..." status="...">
<!--content of type 'epp-trigger'-->
</epp-trigger>
<epp-trigger>
<!--(another 'epp-trigger' type)-->
</epp-trigger>
<!--...more "epp-trigger" elements...-->
</epp-triggers>
</step>
<step>
<!--(another 'step' type)-->
</step>
<!--...more "step" elements...-->
</steps>
<protocol-properties>
<protocol-property name="..." value="...">
<!--content of type 'protocol-property'-->
</protocol-property>
<protocol-property>
<!--(another 'protocol-property' type)-->
</protocol-property>
<!--...more "protocol-property" elements...-->
</protocol-properties>
</protcnf:protocol>
Element protocols
- Type: protocols
Returns the representation of a list of protocols.
A list of protocols available in the system,
providing names and URIs to access more detailed representations of the
protocols.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<protcnf:protocols xmlns:protcnf="http://genologics.com/ri/protocolconfiguration">
<protocol name="..." uri="...">
<!--content of type 'protocol-link'-->
</protocol>
<protocol>
<!--(another 'protocol-link' type)-->
</protocol>
<!--...more "protocol" elements...-->
</protcnf:protocols>
Type protocol
Detailed representation of a protocol.
A protocol represents a collection of different steps.
A protocol can be a QC protocol meaning samples go through the process
mostly in parallel or a normal protocol, where samples go
through in series.
Attributes
| name | type | description |
|---|---|---|
| name | string | Name of the represented protocol |
| index | int | Index of the protocol |
| uri | anyURI | The URI address of the current protocol |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| steps/step (step) | 0/unbounded | List of steps the protocols is using |
| protocol-properties/protocol-property (protocol-property) | 0/unbounded | Protocol configuration properties. |
Type protocol-link
This list will contain a list of names and URIs for all available protocols in the system
Attributes
| name | type | description |
|---|---|---|
| name | string | Name of the protocol |
| uri | anyURI | the URI to access a more detailed representation of the protocol |
Type protocol-property
Protocol-property is a child element of protocol containing key/value pairs for setting specific attributes of protocols. This information contains internally used properties that will change. These properties are suitable for use when copying protocols, but should not be manipulated.
Attributes
| name | type | description |
|---|---|---|
| name | string | The property name. |
| value | string | The property value. |
Type protocols
Returns the representation of a list of protocols.
A list of protocols available in the system,
providing names and URIs to access more detailed representations of the
protocols.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| protocol (protocol-link) | 0/unbounded | Each protocol provides a URI that links to a more detailed representation of the protocol |