Summary
This page contains documentation for update specimen list API.
Request Details
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) 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) Identifier of the specimen. |
specimenListId | Identifier of specimen list. |
Result
The response of this request will contain the details of the updated specimen-list.
URL | http://<host>:<port>/ catissuecore/rest/ng/specimen-lists/{specimenListId} |
Method | PUT |
Content-Type | application/json |
Request | { "label":"SSCP - JC12", "sharedWith":[{"id":2},{"id":3}], "specimens":[{"id":12},{"id":13}] } |
Response | { } |
Error Cases
code | Applies to | Status Message |
---|---|---|
200 | All resources | Specimen-list has been updated successfully. |
400 | All requests | Invalid parameters, e.g duplicate Specimen-list label, Invalid User-ids, Invalid Specimen-ids. |
401 | All requests | Authorization failed, User doesn’t have Authority. |
500 | All requests | Internal server error, Encountered server error while performing operations. |