POST V1 ems/experimentFactors/substrateLists/{substrateListId}/substrates

Adds a substrate to an Experiment substrate list.

Authentication

This endpoint requires the api-username and api-usertoken headers for authentication.

Request Information

Parameters

NameDescriptionAdditional information
substrateListId
The ID of the Substrate List to add the Substrate to.

Define this parameter in the request URI.

experimentSubstrate
Object describing the Substrate to add to the Substrate List:
            
  • Name - the name of the substrate to add to the Substrate List.

Define this parameter in the request body.

Example Request

To add a Substrate with Name "Substrate 1" to the Substrate List with ID 1234, make the following API call:

POST /ems/experimentFactors/substrateLists/1234/substrates

and put the following content in the request body:

Name=Substrate 1

Request body formats

application/json, text/json

Sample:
{
  "Name": "Substrate 1"
}

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:
Name=Substrate 1

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 CodeMeaning
201 (Created) The request has completed successfully. The ID of the experiment substrate will be contained in the response.
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.
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 substrate list does not exist or the parent Experiment has been closed. Ensure the ID has been correctly specified.