POST V1 ems/wells/substrate?plateId={plateId}

Adds a Substrate to all Wells for the specified Plate.

Request Information

Parameters

Name Description Additional information
plateId 
The ID of the Plate containing the Wells to add the Substrate to.

Define this parameter in the request URI.
wellSubstrate 
Object describing the Substrate to add to the Well:
            
  • SubstrateId - the ID of the Substrate to add to the Wells.

Define this parameter in the request body.

Example Request

To add a Substrate with ID 1234 to the Plate with ID 5678, make the following API call:

POST /ems/wells/substrate?plateId=5678

and put the following content in the request body:

SubstrateId=1234

Request body formats

application/json, text/json

Sample: 
{
  "SubstrateId": 1234
}

application/xml, text/xml

Sample: 
<WellSubstrateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unilever.Urdps.Hts.EmsApi.EntityRepresentations.Request.V1">
  <SubstrateId>1234</SubstrateId>
</WellSubstrateRequest>

application/x-www-form-urlencoded

Sample: 
SubstrateId=1234

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.
400 (Bad Request) The data in the request body was invalid. 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) Access Denied. The user does not have write access to the well.
404 (Not Found) The specified well does not exist or the parent Experiment has been closed.
Ensure the ID has been correctly specified.