GET V1 ems/experimentFactors?experimentId={experimentId}
Gets the formulation, substrate and condition factors for the Experiment with the specified ID.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| experimentId | The ID of the Experiment to get the factors for. |
Define this parameter in the request URI. |
Example Request
To get the factors for the Experiment with ID 1234, make the following API call: GET /ems/experimentfactors?experimentId=1234
Response Information
HTTP Status Codes
| Status Code | Meaning |
|---|---|
| 200 (OK) | The request has completed successfully. The Experiment Factors will be contained in the response body (see below). |
Response Detail
An empty collection of factors means that the experiment did not exist or it did not contain any Formulation/Substrate/Condition Factors. Adhoc Formulation/Substrate Factor Values will have a null FRegId.
Response Body Formats
application/json, text/json
Sample:
{
"Formulations": [
{
"ID": 10001,
"Name": "Formulation 1",
"Units": "None",
"Values": [
{
"ID": 11001,
"Value": "Formulation 1 Value 1",
"Type": "Adhoc",
"FRegId": null,
"Description": null,
"LotID": null,
"LotNumber": null,
"Barcode": null
},
{
"ID": 11002,
"Value": "Formulation 1 Value 2",
"Type": "Formulation",
"FRegId": 11101,
"Description": "Description 2",
"LotID": null,
"LotNumber": null,
"Barcode": null
},
{
"ID": 11003,
"Value": "Formulation 1 Value 3",
"Type": "Material",
"FRegId": 11102,
"Description": "Description 3",
"LotID": null,
"LotNumber": null,
"Barcode": null
},
{
"ID": 11004,
"Value": "Formulation 1 Value 4",
"Type": "MaterialLot",
"FRegId": 11103,
"Description": "Description 4",
"LotID": 100,
"LotNumber": "ABC123",
"Barcode": null
}
]
},
{
"ID": 10002,
"Name": "Formulation 2",
"Units": "g",
"Values": []
}
],
"Substrates": [
{
"ID": 20001,
"Name": "Substrate 1",
"Units": "None",
"Values": [
{
"ID": 21001,
"Value": "Substrate 1 Value 1",
"Type": "Adhoc",
"FRegId": null,
"Description": null,
"LotID": null,
"LotNumber": null,
"Barcode": null
},
{
"ID": 21002,
"Value": "Substrate 1 Value 2",
"Type": "Substrate",
"FRegId": 21101,
"Description": "Description 2",
"LotID": null,
"LotNumber": null,
"Barcode": null
},
{
"ID": 21003,
"Value": "Substrate 1 Value 3",
"Type": "SubstrateLot",
"FRegId": 21102,
"Description": "Description 3",
"LotID": 200,
"LotNumber": null,
"Barcode": "XYZ456"
}
]
},
{
"ID": 20002,
"Name": "Substrate 2",
"Units": "g",
"Values": []
}
],
"Conditions": [
{
"ID": 30001,
"Name": "Condition 1",
"Units": "kg",
"Values": [
{
"ID": 31001,
"Value": "25"
},
{
"ID": 31002,
"Value": "58.6"
}
]
},
{
"ID": 30002,
"Name": "Condition 2",
"Units": "None",
"Values": []
}
]
}
application/xml, text/xml
Sample:
<ExperimentFactors xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unilever.Urdps.Hts.EmsApi.EntityRepresentations.EMS.V1">
<Conditions>
<ConditionFactor>
<ID>30001</ID>
<Name>Condition 1</Name>
<Units>kg</Units>
<Values>
<ConditionFactorValue>
<ID>31001</ID>
<Value>25</Value>
</ConditionFactorValue>
<ConditionFactorValue>
<ID>31002</ID>
<Value>58.6</Value>
</ConditionFactorValue>
</Values>
</ConditionFactor>
<ConditionFactor>
<ID>30002</ID>
<Name>Condition 2</Name>
<Units>None</Units>
<Values />
</ConditionFactor>
</Conditions>
<Formulations>
<FormulationFactor>
<ID>10001</ID>
<Name>Formulation 1</Name>
<Units>None</Units>
<Values>
<FormulationFactorValue>
<Barcode i:nil="true" />
<Description i:nil="true" />
<FRegId i:nil="true" />
<ID>11001</ID>
<LotID i:nil="true" />
<LotNumber i:nil="true" />
<Type>Adhoc</Type>
<Value>Formulation 1 Value 1</Value>
</FormulationFactorValue>
<FormulationFactorValue>
<Barcode i:nil="true" />
<Description>Description 2</Description>
<FRegId>11101</FRegId>
<ID>11002</ID>
<LotID i:nil="true" />
<LotNumber i:nil="true" />
<Type>Formulation</Type>
<Value>Formulation 1 Value 2</Value>
</FormulationFactorValue>
<FormulationFactorValue>
<Barcode i:nil="true" />
<Description>Description 3</Description>
<FRegId>11102</FRegId>
<ID>11003</ID>
<LotID i:nil="true" />
<LotNumber i:nil="true" />
<Type>Material</Type>
<Value>Formulation 1 Value 3</Value>
</FormulationFactorValue>
<FormulationFactorValue>
<Barcode i:nil="true" />
<Description>Description 4</Description>
<FRegId>11103</FRegId>
<ID>11004</ID>
<LotID>100</LotID>
<LotNumber>ABC123</LotNumber>
<Type>MaterialLot</Type>
<Value>Formulation 1 Value 4</Value>
</FormulationFactorValue>
</Values>
</FormulationFactor>
<FormulationFactor>
<ID>10002</ID>
<Name>Formulation 2</Name>
<Units>g</Units>
<Values />
</FormulationFactor>
</Formulations>
<Substrates>
<FormulationFactor>
<ID>20001</ID>
<Name>Substrate 1</Name>
<Units>None</Units>
<Values>
<FormulationFactorValue>
<Barcode i:nil="true" />
<Description i:nil="true" />
<FRegId i:nil="true" />
<ID>21001</ID>
<LotID i:nil="true" />
<LotNumber i:nil="true" />
<Type>Adhoc</Type>
<Value>Substrate 1 Value 1</Value>
</FormulationFactorValue>
<FormulationFactorValue>
<Barcode i:nil="true" />
<Description>Description 2</Description>
<FRegId>21101</FRegId>
<ID>21002</ID>
<LotID i:nil="true" />
<LotNumber i:nil="true" />
<Type>Substrate</Type>
<Value>Substrate 1 Value 2</Value>
</FormulationFactorValue>
<FormulationFactorValue>
<Barcode>XYZ456</Barcode>
<Description>Description 3</Description>
<FRegId>21102</FRegId>
<ID>21003</ID>
<LotID>200</LotID>
<LotNumber i:nil="true" />
<Type>SubstrateLot</Type>
<Value>Substrate 1 Value 3</Value>
</FormulationFactorValue>
</Values>
</FormulationFactor>
<FormulationFactor>
<ID>20002</ID>
<Name>Substrate 2</Name>
<Units>g</Units>
<Values />
</FormulationFactor>
</Substrates>
</ExperimentFactors>