Data: ctp
- Namespace: http://genologics.com/ri/containertype
- XML Schema File: containertype.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
- Type: container-type
The detailed representation of a container type.
The container type describes the physical characteristics of a class of containers such as the number of wells in the container as well as describing the coordinate system used for identifying those wells.
The container type is described using a rectangular coordinate system. The characteristics of the horizontal axis are described by the x-dimension element, and the characteristics of the vertical dimension are described by the y-dimension child elements. The characteristics of each dimension included both the size in that dimension as well as the identification method for values in that dimension. Values can be identified either numerically where 0 is the first item or alphabetically where A is the first element. Additionally an offset can be specified which shifts the value of the first element by a fixed amount. When a well location is represented using the coordinate system, it is shown as Y-Value:X-Value (for example A:1).
The following are examples of the coordinate system:
- Y-Dimension: alphabetic, size 1, offset 0. X-Dimension: numeric, size 1, offset 0. Size: 1. Valid value: A:0
- Y-Dimension: alphabetic, size 12, offset 0. X-Dimension: numeric, size 8, offset 0. Size: 96. Valid values: A:0 ... L:7
- Y-Dimension: alphabetic, size 8, offset 0. X-Dimension: numeric, size 12, offset 1. Size: 96. Valid values: A:1 ... H:12
The container type also identifies wells in the container that are not available for storing samples or reagents, either because the configuration of the container requires those wells to be empty for the instrument configuration or because the well contains specific calibrants that are required by the instrument. The well location of the calibrant or unavailable wells is specified using the coordinate system that is described by the x-dimension and y-dimension of the container type.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<ctp:container-type xmlns:ctp="http://genologics.com/ri/containertype" name="..." uri="...">
<is-tube>
<!--content of type 'string'-->
...
</is-tube>
<calibrant-well name="...">...</calibrant-well>
<calibrant-well>
<!--(another 'calibrant-well' type)-->
</calibrant-well>
<!--...more "calibrant-well" elements...-->
<unavailable-well>...</unavailable-well>
<unavailable-well>
<!--(another 'unavailable-well' type)-->
</unavailable-well>
<!--...more "unavailable-well" elements...-->
<x-dimension>
<!--content of type 'dimension'-->
<is-alpha>
<!--content of type 'boolean'-->
...
</is-alpha>
<offset>
<!--content of type 'int'-->
...
</offset>
<size>
<!--content of type 'int'-->
...
</size>
</x-dimension>
<y-dimension>
<!--content of type 'dimension'-->
<is-alpha>
<!--content of type 'boolean'-->
...
</is-alpha>
<offset>
<!--content of type 'int'-->
...
</offset>
<size>
<!--content of type 'int'-->
...
</size>
</y-dimension>
</ctp:container-type>
Element container-types
- Type: container-types
The representation for a list of container type 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"?>
<ctp:container-types xmlns:ctp="http://genologics.com/ri/containertype">
<container-type name="..." uri="...">
<!--content of type 'container-type-link'-->
</container-type>
<container-type>
<!--(another 'container-type-link' type)-->
</container-type>
<!--...more "container-type" elements...-->
<previous-page uri="...">
<!--content of type 'page'-->
</previous-page>
<next-page uri="...">
<!--content of type 'page'-->
</next-page>
</ctp:container-types>
Type calibrant-well
Calibrant-well is a child element of container type and identifies a well location that is reserved for calibrants in containers of the container type.
Attributes
| name | type | description |
|---|---|---|
| name | string |
The name of the calibrant in the well.
Always returns with GET: Yes Creatable with POST: Yes Required for POST: No |
Value
- Type: string
The well location of a well that is reserved for a calibrant in containers of the container type.
Always returns with GET: Yes
Creatable with POST: Yes
Required for POST: No
Type container-type
The detailed representation of a container type.
The container type describes the physical characteristics of a class of containers such as the number of wells in the container as well as describing the coordinate system used for identifying those wells.
The container type is described using a rectangular coordinate system. The characteristics of the horizontal axis are described by the x-dimension element, and the characteristics of the vertical dimension are described by the y-dimension child elements. The characteristics of each dimension included both the size in that dimension as well as the identification method for values in that dimension. Values can be identified either numerically where 0 is the first item or alphabetically where A is the first element. Additionally an offset can be specified which shifts the value of the first element by a fixed amount. When a well location is represented using the coordinate system, it is shown as Y-Value:X-Value (for example A:1).
The following are examples of the coordinate system:
- Y-Dimension: alphabetic, size 1, offset 0. X-Dimension: numeric, size 1, offset 0. Size: 1. Valid value: A:0
- Y-Dimension: alphabetic, size 12, offset 0. X-Dimension: numeric, size 8, offset 0. Size: 96. Valid values: A:0 ... L:7
- Y-Dimension: alphabetic, size 8, offset 0. X-Dimension: numeric, size 12, offset 1. Size: 96. Valid values: A:1 ... H:12
The container type also identifies wells in the container that are not available for storing samples or reagents, either because the configuration of the container requires those wells to be empty for the instrument configuration or because the well contains specific calibrants that are required by the instrument. The well location of the calibrant or unavailable wells is specified using the coordinate system that is described by the x-dimension and y-dimension of the container type.
Attributes
| name | type | description |
|---|---|---|
| name | string |
The name of the container type.
Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes |
| uri | anyURI |
The URI of the container type.
Always returns with GET: Yes Creatable with POST: Yes Required for POST: No |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| is-tube (string) | 0/1 |
is-tube describes if this container-type should be treated as a tube in the client interface.
Always returns with GET: Yes Creatable with POST: Yes Required for POST: No |
| calibrant-well (calibrant-well) | 0/unbounded |
Each calibrant well identifies a well location that is reserved for calibrants in containers of the container type.
Always returns with GET: No Creatable with POST: Yes Required for POST: No |
| unavailable-well (unavailable-well) | 0/unbounded |
Each unavailable well identifies a well location that cannot be used by containers of the container type to store artifacts or reagents.
Always returns with GET: No Creatable with POST: Yes Required for POST: No |
| x-dimension (dimension) | 0/1 |
X-dimension describes the size and identification method of the horizontal axis of the coordinate system for the container type.
Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes |
| y-dimension (dimension) | 0/1 |
Y-dimension describes the size and identification method of the vertical axis of the coordinate system for the container type.
Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes |
Type container-type-link
Container-type-link is a child element type of containers and provides a URI linking to the detailed representation of a container type.
Attributes
| name | type | description |
|---|---|---|
| name | string | The name of the container type. |
| uri | anyURI | The URI of the container type. |
Type container-types
The representation for a list of container type 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-type (container-type-link) | 0/unbounded | Container-type provides a URI linking to the detailed representation of a container type. |
| previous-page (page) | 0/1 | When working with large lists of container types, the previous-page element provides a URI that links to the previous page of container types. |
| next-page (page) | 0/1 | When working with large lists of container types, the next-page element provides a URI that links to the next page of container types. |
Type dimension
Dimension is a child element of container type and describes the size and identification method of the horizontal and vertical dimensions of the coordinate system of the container type.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| is-alpha (boolean) | 0/1 |
The is-alpha flag is used for identifying well location.
When is-alpha is true, the component of the well location from the dimension is represented using letters where A is the first value. Whe is-alpha is false, the component of the well location from the dimension is represented using numbers where 0 is the first value. Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes |
| offset (int) | 0/1 |
The offset of this dimension.
If is-alpha is true, the system will ignore any value provided for POST and use 0 for alpha offset. Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes |
| size (int) | 0/1 |
The size of this dimension, 1-100
Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes |
Type unavailable-well
Unavailable-well is a child element of container type and identifies a well location that cannot be used by containers of the container type to store artifacts or reagents.
Value
- Type: string
The well location of a well that is not available for containers of the container type.
Always returns with GET: Yes
Creatable with POST: Yes
Required for POST: No