POST V1 ems/plates

Adds a Plate to an Experiment.

Request Information

Parameters

Name Description Additional information
plate 
Object describing the Plate to add to the Experiment:
            
  • ExperimentId - the Experiment to add the Plate to.
            
  • Name - [OPTIONAL] the name for the new plate, 200 characters maximum. Must be unique in the experiment.
    If not supplied, the default plate type name will be used.
            
  • Barcode - [OPTIONAL] the barcode for the new plate, 200 characters maximum. Must be unique in the experiment.
    If not supplied, no barcode will be assigned to the plate.

Define this parameter in the request body.

Example Request

To add a Plate with the name "Plate Name" and barcode "BARCODE12345" to the experiment 1234, make the following API call:

POST /ems/plates

and put the following content in the request body:

ExperimentId=12345&Name=Plate Name&Barcode=BARCODE123

Request body formats

application/json, text/json

Sample: 
{
  "ExperimentId": 12345,
  "Name": "Plate Name",
  "Barcode": "BARCODE123"
}

application/xml, text/xml

Sample: 
<Plate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unilever.Urdps.Hts.EmsApi.EntityRepresentations.Request.V1">
  <Barcode>BARCODE123</Barcode>
  <ExperimentId>12345</ExperimentId>
  <Name>Plate Name</Name>
</Plate>

application/x-www-form-urlencoded

Sample: 
ExperimentId=12345&Name=Plate Name&Barcode=BARCODE123

Request Detail

This request should be made with the Content-Type header set to 'application/x-www-form-urlencoded', 'application/json' or 'application/xml'.

This endpoint requires the api-username and api-usertoken headers to be present. If these headers are not present, a 401 (Unauthorized) response will be returned.

Response Information

HTTP Status Codes

Status Code Meaning
201 (Created) The request has completed successfully. The ID of the new plate will be contained in the response.
400 (Bad Request) The data in the request body was invalid
OR the parent experiment doesn't exist or is closed
OR the experiment doesn't have a default plate type
OR the plate name supplied is not unique in the experiment
OR the barcode supplied is not unique in the experiment.
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 write access to the specified experiment.
503 (ServiceUnavailable) EMS is currently unavailable.
Please try again later or contact a system administrator to ask when EMS will be back online.