POST V1 ems/wells/{wellId}/formulation

Adds a formulation to a Well.

Request Information

Parameters

Name Description Additional information
wellId 
The ID of the Well to add the Formulation to.

Define this parameter in the request URI.
wellFormulation 
Object describing the Formulation to add to the Well:
            
  • FormulationId - the ID of the Formulation to add to the Well.
    • FormulationListId - the ID of the Formulation list you want to add the formulation from.

Define this parameter in the request body.

Example Request

To add a Formulation with ID 1234 to the Well with ID 5678, make the following API call:

POST /ems/wells/5678/formulation

and put the following content in the request body:

FormulationId=1234

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.

Request body formats

application/json, text/json

Sample: 
{
  "FormulationId": 1234,
  "FormulationListId": 5678
}

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample: 
FormulationId=1234&FormulationListID=5678

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