/jobs/{jobID}/validate

Validates an import job and returns a list of rows as well as rows that failed validation according to model settings.

If the importMethod is set to CleanAndReplace, the /validate endpoint also returns an additional cleanAndReplaceAffectedRows property. This property displays a list of dimension value combinations that represent all rows that will be either cleaned or deleted from the target model before proceeding with the import. As a result, any row in the target model that matches the dimension values in the cleanAndReplaceAffectedRows property will be deleted automatically.

API Request Details

URL	`{BaseURL}/jobs/{jobID}/validate`
Request Type	POST
Content Type	application/json
Required Header
Name	x-csrf-token
Value	<token>

Sample Response

201: Created

{ 
    "jobStatus": "READY_FOR_WRITE", 
    "totalNumberRowsInJob": 1000, 
    "failedNumberRows": 0, 
    "invalidRowsURL": "{BaseUrl}/jobs/432661d8-8d62/invalidRows", 
    "jobStatusURL": "{BaseUrl}/jobs/432661d8-8d62/status" 
}

The example below is a sample response using the CleanAndReplace import method.

{ 
    "jobStatus": "READY_FOR_WRITE", 
    "totalNumberRowsInJob": 1000, 
    "failedNumberRows": 0, 
    "invalidRowsURL": "{BaseUrl}/jobs/432661d8-8d62/invalidRows", 
    "jobStatusURL": "{BaseUrl}/jobs/432661d8-8d62/status" 
    “additionalInformation”: { 
        “cleanAndReplaceAffectedRows”: [ 
{ 
    “Version”: “public.Actual”, 
    “Bicycle”: “TX100” 
} 
        ] 
    } 
}

Error Responses

HTTP Status Code	Returns
400	`Bad Request`
403	`Unauthorized`
404	`Not Found`
500	`Unexpected Error`