POST V1 ems/experimentFactors/substrateLists

Adds a substrate list to an Experiment.

Request Information

Parameters

Name Description Additional information
experimentSubstList 
Object describing the Substrate List to add to the Experiment:
            
  • ExperimentId - the ID of the Experiment to add the Substrate List to.
  • Name - the name of the Substrate List to add to the Experiment.
    		•

    Define this parameter in the request body.

    Example Request

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

    POST /ems/experimentFactors/substrateLists

    and put the following content in the request body:

    ExperimentId=1234&ListName=Substrate List 1

    Request body formats

    application/json, text/json

    Sample: 
    {
  "ExperimentId": 123,
  "Name": "Substrate List 1"
}

    application/xml, text/xml

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

    application/x-www-form-urlencoded

    Sample: 
    ExperimentId=123&Name=Substrate List 1

    Request Detail

    This request does not currently support specifying an Amounts List for the Substrate List.
    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 experiment condition 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 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 Experiment with the specified ID could not be found or has been closed.
    Ensure the ID has been correctly specified.