Use the following resource to create new specimen list in the OpenSpecimen application. Use HTTP POST method to call this API by passing the below details in JSON format.
Resource:
catissuecore/rest/ng/users
Below are the attributes which need to be sent in the request body:
Parameter | Details |
---|---|
label | A display name for Specimen-list. |
sharedWith | Collection of Users with whom the list is shared with. This member is optional. |
id | (sharedWith -> id) User id of the person with whom the list is shared with. |
specimens | Collection of specimens which belong to the given list. A Specimen-list can have one or more specimens in it. This member is optional. |
id | (specimens -> id) Identifier of the specimen. |
http[s]:<host>:<port>/catissuecore/rest/ng/specimen-lists
Use this URL to add a new Specimen-list in OpenSpecimen.
Result:
The response of this request will contain the details of the newly created specimen-list.
Please find request, response details below.
URL | http://<host>:<port>/ catissuecore/rest/ng/specimen-lists |
Method | POST |
Content-Type | application/json |
Request | { "label":"Brain Cancer CP - C123 - S1", "sharedWith":[{"id":2},{"id":3}], "specimens":[{"id":12},{"id":13}] } |
Response |