GET V1 ems/results?experimentId={experimentId}
Starts an experiment result search in EMS. Note that this is the V1 controller implementation of this endpoint.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| experimentId |
The ID of the experiment, whose results are required. |
Define this parameter in the request URI. |
Example Request
To obtain the results from an EMS experiment, make the following API call: GET /ems/results?experimentId={experimentId}
The result search may take some time to complete, so please ensure clients allow a sufficient timeout (allow several minutes). Once the export has completed, the client can obtain the results by passing the ID to the results export endpoint. If the export does not complete in a reasonable amount of time, please check the EMS error logs for details.
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.
Response Information
HTTP Status Codes
| Status Code | Meaning |
|---|---|
| 202 (Accepted) | The request has completed successfully. The search has been accepted by the system and will be processed asynchronously. |
| 400 (Bad Request) | The provided Experiment ID is not a valid number. |
| 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 Experiment with the specified ID could not be found or has been closed. Ensure the ID has been correctly specified. |
| 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. |
| 503 (ServiceUnavailable) | EMS is currently unavailable. Please try again later or contact a system administrator to ask when EMS will be back online. |
Response Body Formats
application/json, text/json
{
"DatasetID": 12345,
"ResultSetCount": 5
}
application/xml, text/xml
<ResultExport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unilever.Urdps.Hts.EmsApi.EntityRepresentations.Results.V1"> <DatasetID>12345</DatasetID> <ResultSetCount>5</ResultSetCount> </ResultExport>