Samples & Products¶
Endpoints related to samples & products.
- POST /product/<uuid:product_uuid>/clone/¶
- Status Codes:
201 Created – Resource created successfully
404 Not Found – The requested product cannot be found.
403 Forbidden – You are not authorized to complete the request.
- Response Headers:
Location – URI of the created resource
- GET /specimen/¶
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
404 Not Found – RecordNotFound: The Specimens cannot be found.
403 Forbidden – Unauthorized: You do not have the necessary specimen permissions to complete the request.
- POST /specimen/¶
- Status Codes:
201 Created – Resource created successfully
404 Not Found – RecordNotFound: The Specimens cannot be found.
403 Forbidden – Unauthorized: You do not have the necessary specimen permissions to complete the request.
- Response Headers:
Location – URI of the created resource
- GET /specimen/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
404 Not Found – RecordNotFound: The Specimens cannot be found.
403 Forbidden – Unauthorized: You do not have the necessary specimen permissions to complete the request.
- PUT /specimen/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource updated successfully
404 Not Found – RecordNotFound: The Specimens cannot be found.
403 Forbidden – Unauthorized: You do not have the necessary specimen permissions to complete the request.
- DELETE /specimen/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource deleted successfully
404 Not Found – RecordNotFound: The Specimens cannot be found.
403 Forbidden – Unauthorized: You do not have the necessary specimen permissions to complete the request.
- GET /sample/¶
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
404 Not Found – The requested sample cannot be found.
405 Method Not Allowed – MethodNotAllowed
- POST /sample/¶
- Status Codes:
201 Created – Resource created successfully
404 Not Found – The requested sample cannot be found.
405 Method Not Allowed – MethodNotAllowed
- Response Headers:
Location – URI of the created resource
- GET /sample/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
404 Not Found – The requested sample cannot be found.
405 Method Not Allowed – MethodNotAllowed
- PUT /sample/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource updated successfully
404 Not Found – The requested sample cannot be found.
405 Method Not Allowed – MethodNotAllowed
- DELETE /sample/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource deleted successfully
404 Not Found – The requested sample cannot be found.
405 Method Not Allowed – MethodNotAllowed
- GET /product/¶
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
404 Not Found – The requested product cannot be found.
405 Method Not Allowed – MethodNotAllowed
- POST /product/¶
- Status Codes:
201 Created – Resource created successfully
404 Not Found – The requested product cannot be found.
405 Method Not Allowed – MethodNotAllowed
- Response Headers:
Location – URI of the created resource
- GET /product/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
404 Not Found – The requested product cannot be found.
405 Method Not Allowed – MethodNotAllowed
- PUT /product/{uuid}/¶
Allow to move product from “pending” to “confirmed”.
Allow to move product from “pending” to “confirmed”.
Status is the only field which can be changed via PUT now.
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource updated successfully
404 Not Found – The requested product cannot be found.
405 Method Not Allowed – MethodNotAllowed
- DELETE /product/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource deleted successfully
404 Not Found – The requested product cannot be found.
405 Method Not Allowed – MethodNotAllowed