Versions Compared

Key

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

...

URLhttp://<host>:<port>/openspecimen/rest/ng/container-types
MethodPOST
Requestapplication/json
json
Code Block
languagejs
themeEclipse
linenumberstrue
{
  "name":"Freezer",
  "nameFormat":"F-%SITE_UID%",
  "noOfRows":"5",
  "noOfColumns":"5",
  "rowLabelingScheme":"Numbers",
  "columnLabelingScheme":"Numbers",
  "temperature":"-80",
  "storeSpecimenEnabled":false,
  "canHold":{
    "id":2,
    "name":"Rack"
   }
}

Response

Code Block
languagejs
themeEclipse
linenumberstrue
{
  "id": 13,
  "name": "Test1",
  "nameFormat": "T-%SITE_UID%",
  "noOfColumns": 5,
  "noOfRows": 5,
  "columnLabelingScheme": "Numbers",
  "rowLabelingScheme": "Numbers",
  "temperature": -80,
  "storeSpecimenEnabled": false,
  "activityStatus": "Active",
  "canHold": {
    "id": 2,
    "name": "Rack",
    "nameFormat": "%PCONT_NAME%-RK-%PCONT_UID%",
    "noOfColumns": 10,
    "noOfRows": 10,
    "columnLabelingScheme": "Numbers",
    "rowLabelingScheme": "Numbers",
    "temperature": -90,
    "storeSpecimenEnabled": true,
    "activityStatus": "Active"
  }
}

 

 Error Cases :

 

code
Applies to
Status Message
200All resourcesCollection Protocol Event Container type has been created successfully
400All requestsInvalid parameters, e.g  duplicate event label, blank event label etc
401All requestsAuthorization failed, user doesn’t have authority
500All requestsInternal server error, encountered server error while performing operations