PUT V1 ems/protocolConditions/{conditionId}
Updates the Value and Units for the specified Protocol Condition on an Experiment.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
conditionId |
The Id of the Protocol Condition to edit. |
Define this parameter in the request URI. |
protocolCondition |
Object describing the Condition to edit on the Experiment:
|
Define this parameter in the request body. |
Example Request
To update the Protocol Condition Value and Units to "Value 1" and "Unit 2" for the Protocol Condition with ID 1234 make the following API call:
PUT /ems/protocolConditions/1234
and put the following content in the request body:
Value=Value 1&Units=Units 2
Request body formats
application/json, text/json
Sample:
{ "Value": "Value 1", "Units": "Unit 2" }
application/xml, text/xml
Sample:
<ProtocolConditionBasic xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unilever.Urdps.Hts.EmsApi.EntityRepresentations.EMS.V1"> <Units>Unit 2</Units> <Value>Value 1</Value> </ProtocolConditionBasic>
application/x-www-form-urlencoded
Sample:
Value=Value 1&Units=Unit 2
Request Detail
This request should be made with the Content-Type header set to 'application/x-www-form-urlencoded', 'application/json' or 'application/xml'.
Response Information
HTTP Status Codes
Status Code | Meaning |
---|---|
204 (No Content) | The request has completed successfully. The value and units for the specified protocol condition will have been updated. |
400 (Bad Request) | The protocol conditoin value or units are not valid for the protocol condition. The nature of the error will be indicated in the Response content. |
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 specified protocol conditon does not exist or the parent Experiment has been closed. Ensure the ID has been correctly specified. |