Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

 

ParameterDetails
nameContainer type name for search
canHoldName of holding container type. Ex: To search containers who holds 'Boxes
exactMatchFlag to specify whether to perform exact match or not.
startAtstart index of the results
maxResultsMaximum number of records to fetch. By default it will be 1000


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:

URLhttp://<host>:<port>/openspecimen/rest/ng/container-types
MethodGET
Requestapplication/json

Response

1

 

2

 

3
Code Block
4
language
5[
{
js
6
7
8
9
10
11
12
13
14
15
16
17
linenumberstrue
[
 {
 "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"

}]

 }
]