POST V1 ems/plates/{plateId}/comment

Adds a Comment to the Plate with the specified ID.

Request Information

Parameters

Name Description Additional information
plateId 
The ID of the Plate to add a Comment to.

Define this parameter in the request URI.
plateComment 
Object describing the Comment to add to the Plate:
  • Comment - the Comment to add to the Plate (<= 2000 characters).
  • UserEmail - the Email address of the User adding the Comment.

Define this parameter in the request body.

Example Request

To add a Comment of "a comment" from the User "joe.bloggs@example.com" for the Plate with ID 1234, make the following API call:

PUT /ems/plates/1234/comment

and put the following content in the request body:

Comment=a comment&UserEmail=joe.bloggs@example.com

Request body formats

application/json, text/json

Sample: 
{
  "Comment": "a comment",
  "UserEmail": "joe.bloggs@example.com"
}

application/xml, text/xml

Sample: 
<PlateComment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unilever.Urdps.Hts.EmsApi.EntityRepresentations.Request.V1">
  <Comment>a comment</Comment>
  <UserEmail>joe.bloggs@example.com</UserEmail>
</PlateComment>

application/x-www-form-urlencoded

Sample: 
Comment=a comment&UserEmail=joe.bloggs@example.com

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
201 (Created) The request has completed successfully. The ID of the new comment will be contained in the response.
400 (Bad Request) The data in the request body was invalid OR the email address supplied did not relate to an EMS user. 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 plate does not exist or the parent Experiment has been closed. Ensure the ID has been correctly specified.