Data: que
- Namespace: http://genologics.com/ri/queue
- XML Schema File: queue.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 queue
- Type: queue
The representation of a queue.
It represents and is used to list all of the elements contained within a queue. A queue is a representation of
samples that are ready to run through a Protocol Step.
Each artifact listed in the queue will contain elements to show when it was queued and its container location.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<que:queue xmlns:que="http://genologics.com/ri/queue" uri="..." protocol-step-uri="..." name="...">
<artifacts>
<artifact uri="..." limsid="...">
<!--content of type 'artifact-link'-->
<queue-time>
<!--content of type 'dateTime'-->
...
</queue-time>
<location>
<!--content of type 'location'-->
<container limsid="..." uri="...">
<!--content of type 'container'-->
</container>
<value>
<!--content of type 'string'-->
...
</value>
</location>
</artifact>
<artifact>
<!--(another 'artifact-link' type)-->
</artifact>
<!--...more "artifact" elements...-->
</artifacts>
<previous-page uri="...">
<!--content of type 'page'-->
</previous-page>
<next-page uri="...">
<!--content of type 'page'-->
</next-page>
</que:queue>
Type artifact-link
Artifact-link is a child element type of artifacts and provides a URI linking to the detailed representation of an artifact.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI | The URI of the artifact. |
| limsid | string | The LIMSID of the artifact. |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| queue-time (dateTime) | 0/1 | The Timestamp representing when the artifact was queued |
| location (location) | 0/1 | The container placement of the artifact. |
Type queue
The representation of a queue.
It represents and is used to list all of the elements contained within a queue. A queue is a representation of
samples that are ready to run through a Protocol Step.
Each artifact listed in the queue will contain elements to show when it was queued and its container location.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI | The URI of the queue. |
| protocol-step-uri | anyURI | (no documentation provided) |
| name | string | The name of the queue (protocol step) |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| artifacts/artifact (artifact-link) | 0/unbounded | Artifact provides a URI linking to the detailed representation of an artifact. |
| previous-page (page) | 0/1 | When working with large lists of artifacts, the previous-page element provides a URI that links to the previous page of artifacts. |
| next-page (page) | 0/1 | When working with large lists of artifacts, the next-page element provides a URI that links to the next page of artifacts. |