/{version}/containertypes
The following operations are supported on this resource:
GET
Displays a list of the types of containers stored in the system. If the number of container types returned exceeds the display maximum, the results are paged.
When submitting a GET request, you can use the following query parameters to filter the results. For more information about using query parameters, please refer to [REST:Filtering list resources].
Parameters
| name | description | type | default |
|---|---|---|---|
| start-index | When working with large lists of container types, displays the containers from a set point. If omitted, the first page of results is returned. | query | 0 |
| name | Displays only the container types whose name matches the specified value (the name of a container type). When filtering results, you can repeat this parameter. | query |
Output Payload
| element | produceable content type(s) |
|---|---|
| container-types (XML) |
|
| description | |
| The system returns a response that includes a list of container types and URI links, starting from the start-index offset. | |
POST
POST a containerType to the system.
Every element in container-type is POSTable, including the name (non-unique) attribute of the container-type tag pair. <calibrant-well> and <unavailable-well> nodes are NOT required for POST. If provided, the value must be a Y:X based co-ordinate that is valid, based on offsets, size, and is-alpha values.
All dimension child elements are required fields for POST.
Input Payload
| element | consumeable content type(s) |
|---|---|
| container-type (XML) |
|
| description | |
| new containerType to create. Here is an example <container-type> in xml format: <ctp:container-type xmlns:ctp="http://genologics.com/ri/containertype" name="96 well plate api demo"> <x-dimension> <is-alpha>false</is-alpha> <offset>1</offset> <size>12</size> </x-dimension> <y-dimension> <is-alpha>true</is-alpha> <offset>0</offset> <size>8</size> </y-dimension> </ctp:container-type> |
|
Output Payload
| element | produceable content type(s) |
|---|---|
| container-type (XML) |
|
| description | |
| HTTP Status 201 (Created) with the URI to new ContainerType in the Location header of the response.
The representation for the newly created ContainerType will be returned as the response body.
Here is an example response in xml format: <ctp:container-type xmlns:ctp="http://genologics.com/ri/containertype" uri="http://qafunc03:8080/api/v2/containertypes/60" name="96 well plate api demo"> <x-dimension> <is-alpha>false</is-alpha> <offset>1</offset> <size>12</size> </x-dimension> <y-dimension> <is-alpha>true</is-alpha> <offset>0</offset> <size>8</size> </y-dimension> </ctp:container-type> |
|
GET
Displays a list of the types of containers stored in the system. If the number of container types returned exceeds the display maximum, the results are paged.
When submitting a GET request, you can use the following query parameters to filter the results. For more information about using query parameters, please refer to [REST:Filtering list resources].
Parameters
| name | description | type | default |
|---|---|---|---|
| start-index | When working with large lists of container types, displays the containers from a set point. If omitted, the first page of results is returned. | query | 0 |
| name | Displays only the container types whose name matches the specified value (the name of a container type). When filtering results, you can repeat this parameter. | query |
Output Payload
| element | produceable content type(s) |
|---|---|
| container-types (XML) |
|
| description | |
| The system returns a response that includes a list of container types and URI links, starting from the start-index offset. | |
POST
POST a containerType to the system.
Every element in container-type is POSTable, including the name (non-unique) attribute of the container-type tag pair.
All dimension child elements are required fields for POST.
Input Payload
| element | consumeable content type(s) |
|---|---|
| container-type (XML) |
|
| description | |
| new containerType to create. \\ Here is an example |
|
Output Payload
| element | produceable content type(s) |
|---|---|
| container-type (XML) |
|
| description | |
| HTTP Status 201 (Created) with the URI to new ContainerType in the Location header of the response.
The representation for the newly created ContainerType will be returned as the response body.
Here is an example response in xml format:\\
\\
{{ |
|