POST V1 ems/experimentFactors/formulationLists/{formulationListId}/formulations

Adds a formulation to an Experiment formulation list.

Request Information

Parameters

Name Description Additional information
formulationListId 
The ID of the Formulation List to add the Formulation to.

Define this parameter in the request URI.
experimentFormulation 
Object describing the Formulation to add to the Formulation List:
            
  • FlowId - the Flow Id of the formulation to add to the Formulation List.

Define this parameter in the request body.

Example Request

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.

To add a Formulation with the Flow ID of 123456 to the Formulation List with ID 1234, make the following API call:

POST /ems/experimentFactors/formulationLists/1234/formulations

and put the following content in the request body:

FlowId=123456

Request body formats

application/json, text/json

Sample: 
{
  "FlowId": 123456
}

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample: 
FlowId=123456

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 experiment formulation 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.
404 (Not Found) The specified formulation list does not exist or the formulation could not befound in Flow or the parent Experiment has been closed. Ensure the ID has been correctly specified.
403 (Forbidden) The user does not have permission to access the formulation list's parent experiment.
Please use EMS to add the user to the experiment access control list.
503 (ServiceUnavailable) EMS is currently unavailable.
Please try again later or contact a system administrator to ask when EMS will be back online.