DELETE V1 stability/samples/{id}?deletionReasonId={deletionReasonId}&deleteFutureSamples={deleteFutureSamples}
Deletes the Stability Sample with the specified id. Optionally deletes all future samples for this product/temperature combination.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
id |
The ID of the Stability Sample to delete. |
Define this parameter in the request URI. |
deletionReasonId |
The ID of the sample deleted reason to describe why the sample(s) were deleted. |
Define this parameter in the request URI. |
deleteFutureSamples |
If set to true, deletes all future samples for this product/temperature combination. Otherwise only the specified sample will be deleted. |
Define this parameter in the request URI. |
Example Request
To delete the Stability Sample with ID 12345 because of deletion reason id 3 and to delete all future samples for the same product/temperature combination, make the following API call: DELETE /stability/samples/12345?deletionReasonId=3&deleteFutureSamples=true
Request Detail
Note that no action will be performed on a Sample if it has already been deleted or has already been measured.
Response Information
HTTP Status Codes
Status Code | Meaning |
---|---|
204 (No Content) | The request has completed successfully. The Stability Sample (and optionally all future samples for the same product/temperature combination) will have been deleted. |
400 (Bad Request) | The Deletion Reason ID specified does not exist. Ensure the ID has been correctly specified. |
401 (Unauthorized) | The user has not been authorised due to the below reasons which will be displayed in the
response
content.
API Key is not found. Data received apiKey
Secret Key is wrong. Data received apiKey
Username not found. Data received apiKey
Received token not found in EMS issuer. Data received username ,
version
Lifetime validation failed. The token is expired. ValidTo (UTC):
expiry , Current time
(UTC): UTC DateTime
Token creation failed. Reason: The given username or password is wrong. For input:
username , version
Please ensure that the client provides the api-username and
api-usertoken headers.
|
403 (Forbidden) | The user does not have permission to access the specified experiment. Please use EMS to add the user to the experiment access control list. |
404 (Not Found) | The Stability Sample with the specified ID could not be found or the parent Experiment has been closed. Ensure the ID has been correctly specified. |