Get Container Types

openspecimen/rest/ng/container-types

or

openspecimen/rest/ng/container-types?name={container_type_name}&canHold={holding_container_type}&exactMatch={true/false}&startAt={start_at}&maxResults={max_results}

Use above resource to get list of all container types. By passing given optional parameters we can filter out result.

Use HTTP GET method to call this API by passing the below optional request parameters.

Parameter	Details
name	Container type name for search
canHold	Name of holding container type. Ex: To search types which holds 'Boxes'
exactMatch	Flag to specify whether to perform exact match or not.
startAt	start index of the results
maxResults	Maximum number of records to fetch. By default it will be 100

Result:

The response of this request will contains the list of matching criteria container types

Below is the example of the get all container types:

URL	`http://<host>:<port>/`openspecimen/rest/ng/container-types
Method	GET
Request	application/json
Response	[ { "id": 1, "name": "Box", "nameFormat": "%PCONT_NAME%-B-%PCONT_ALPHA_SEQ%", "noOfColumns": 9, "noOfRows": 10, "columnLabelingScheme": "Alphabets Upper Case", "rowLabelingScheme": "Alphabets Upper Case", "temperature": -90, "storeSpecimenEnabled": true, "activityStatus": "Active" }, { "id": 3, "name": "Freezer", "nameFormat": "FD-%SITE_UID%", "noOfColumns": 6, "noOfRows": 6, "columnLabelingScheme": "Numbers", "rowLabelingScheme": "Numbers", "temperature": -90, "storeSpecimenEnabled": false, "activityStatus": "Active" }, { "id": 2, "name": "Rack", "nameFormat": "%PCONT_NAME%-RK-%PCONT_UID%", "noOfColumns": 10, "noOfRows": 10, "columnLabelingScheme": "Numbers", "rowLabelingScheme": "Numbers", "temperature": -90, "storeSpecimenEnabled": true, "activityStatus": "Active" } ]