GET V1 ems/validate?entityType={entityType}&entityId={entityId}

Gets the validation results for a specific Entity.

Request Information

Parameters

NameDescriptionAdditional information
entityType 
The Entity Type. This should be one of the following types:
            Experiment

Define this parameter in the request URI.
entityId 
The Entity ID. This should be an ID that exists for the Entity Type specified.

Define this parameter in the request URI.

Example Request

To validate the experiment with ID 1234, make the following API call: GET /ems/validate?entityType=Experiment&entityId=1234

Response Information

HTTP Status Codes

Status CodeMeaning
200 (OK) Validation has been performed. The validation results will be contained in the response body (see below).
400 (Bad Request) The Entity could not be validated. Ensure the Entity Type and ID have been correctly specified.

Response Detail

The ValidationErrors property in the response object will only be populated if IsValid is false. The InfoMessages property may or may not be populated.

Response Body Formats

application/json, text/json

Sample: 
{
  "IsValid": false,
  "ValidationErrors": [
    "Validation Error 1",
    "Validation Error 2"
  ],
  "InfoMessages": [
    "Information Message 1",
    "Information Message 2"
  ]
}

application/xml, text/xml

Sample: 
<EntityValidationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unilever.Urdps.Hts.EmsApi.EntityRepresentations.Validation.V1">
  <InfoMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Information Message 1</d2p1:string>
    <d2p1:string>Information Message 2</d2p1:string>
  </InfoMessages>
  <IsValid>false</IsValid>
  <ValidationErrors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Validation Error 1</d2p1:string>
    <d2p1:string>Validation Error 2</d2p1:string>
  </ValidationErrors>
</EntityValidationResult>