Data: con
- Namespace: http://genologics.com/ri/container
- XML Schema File: container.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 container
- Type: container
The detailed representation of a container.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<con:container xmlns:con="http://genologics.com/ri/container" limsid="..." uri="...">
<name>
<!--content of type 'string'-->
...
</name>
<type name="..." uri="...">
<!--content of type 'container-type'-->
</type>
<occupied-wells>
<!--content of type 'long'-->
...
</occupied-wells>
<placement limsid="..." uri="...">
<!--content of type 'placement'-->
<value>
<!--content of type 'string'-->
...
</value>
</placement>
<placement>
<!--(another 'placement' type)-->
</placement>
<!--...more "placement" elements...-->
<udf:type xmlns:udf="http://genologics.com/ri/userdefined">...</udf:type>
<udf:field xmlns:udf="http://genologics.com/ri/userdefined">...</udf:field>
<udf:field xmlns:udf="http://genologics.com/ri/userdefined">...</udf:field>
<!--...more "field" elements...-->
<state>
<!--content of type 'string'-->
...
</state>
</con:container>
Element containers
- Type: containers
The representation for a list of container links.
The system enforces a maximum number of elements when generating the list of links. When the size of
the request result set is larger than the system maximum, the list represents a paged view of the overall
results, and the previous-page and next-page elements provide URIs linking to the previous or next page
of links in the overall results.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<con:containers xmlns:con="http://genologics.com/ri/container">
<container limsid="..." uri="...">
<!--content of type 'container-link'-->
<name>
<!--content of type 'string'-->
...
</name>
</container>
<container>
<!--(another 'container-link' type)-->
</container>
<!--...more "container" elements...-->
<previous-page uri="...">
<!--content of type 'page'-->
</previous-page>
<next-page uri="...">
<!--content of type 'page'-->
</next-page>
</con:containers>
Element details
- Type: details
The representation of a list of resource details.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<con:details xmlns:con="http://genologics.com/ri/container">
<con:container limsid="..." uri="...">
<!--content of type 'container'-->
<name>
<!--content of type 'string'-->
...
</name>
<type name="..." uri="...">
<!--content of type 'container-type'-->
</type>
<occupied-wells>
<!--content of type 'long'-->
...
</occupied-wells>
<placement limsid="..." uri="...">
<!--content of type 'placement'-->
<value>
<!--content of type 'string'-->
...
</value>
</placement>
<placement>
<!--(another 'placement' type)-->
</placement>
<!--...more "placement" elements...-->
<udf:type xmlns:udf="http://genologics.com/ri/userdefined">...</udf:type>
<udf:field xmlns:udf="http://genologics.com/ri/userdefined">...</udf:field>
<udf:field xmlns:udf="http://genologics.com/ri/userdefined">...</udf:field>
<!--...more "field" elements...-->
<state>
<!--content of type 'string'-->
...
</state>
</con:container>
<con:container>
<!--(another 'container' type)-->
</con:container>
<!--...more "container" elements...-->
</con:details>
Type container
The detailed representation of a container.
Attributes
| name | type | description |
|---|---|---|
| limsid | string | The LIMS ID of the container. |
| uri | anyURI | The URI of the container. |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| name (string) | 0/1 | The name (identifier) of the container. |
| type (container-type) | 0/1 | A URI that links to the container type that the container is associated with. |
| occupied-wells (long) | 0/1 | The number of wells in the container that contain an artifact. |
| placement (placement) | 0/unbounded | A URI that links to an artifact that resides in a well in the container. The placement element is repeated for each populated well in the container. |
| type () | 0/1 | The User-Defined Type associated with the container. |
| field () | 0/unbounded | The User-Defined Field that is associated with the container. This element is repeated for each UDF associated with the container. |
| state (string) | 0/1 | The state of the container. A container can include one of the following states: Empty, Populated, Discarded, or Depleted. |
Type container-link
Container-link is a child element type of containers and provides a URI linking to the detailed representation of a container.
Attributes
| name | type | description |
|---|---|---|
| limsid | string | The LIMSID of the container. |
| uri | anyURI | The URI of the container. |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| name (string) | 0/1 | The name of the container. |
Type containers
The representation for a list of container links.
The system enforces a maximum number of elements when generating the list of links. When the size of
the request result set is larger than the system maximum, the list represents a paged view of the overall
results, and the previous-page and next-page elements provide URIs linking to the previous or next page
of links in the overall results.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| container (container-link) | 0/unbounded | Container provides a URI linking to the detailed representation of a container. |
| previous-page (page) | 0/1 | When working with large lists of containers, the previous-page element provides a URI that links to the previous page of containers. |
| next-page (page) | 0/1 | When working with large lists of containers, the next-page element provides a URI that links to the next page of containers. |
Type container-type
Container-type is a child element of container and provides a URI linking to the detailed representation of the container type that the container is associated with. A container type describes the physical characteristics of the container, such as the number of wells in the container and how the wells are labeled.
Attributes
| name | type | description |
|---|---|---|
| name | string | The name of the container type. |
| uri | anyURI | The URI of the container type. |
Type details
The representation of a list of resource details.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| container (container) | 0/unbounded | (no documentation provided) |
Type placement
Placement is a child element of container and provides a URI linking to the detailed representation of the artifact that is located in a specific well of the container.
Attributes
| name | type | description |
|---|---|---|
| limsid | string | The LIMS ID of the artifact in the container well. |
| uri | anyURI | The URI of the artifact in the well. |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| value (string) | 0/1 | The location of a well in the container, in Y:X format. The coordinates used depend on how the container type is configured in the system, such as 1:1, A:1, or 1:A. |