Introduction

All Resource, Form or Record creation API requests will provide a Request ID that can be accessed within the GetBatchStatus to see if a request has processed, returned an error or was successful. Requests that have errors preventing the request from being processed will not generate a RequestID to pass to this API.

Getting Started

All API requests require an authorization token – reference our Authentication page for more information

Get Batch Status

UI Reference

For a visual confirmation of the same information accessible with the GetBatchStatus API within the UI the Data Provisioning Admin Tools Module tracks the same status and reference information.

API Module

Get updates on the status of one or more requests made via other API’s.

API Structure

POST api/integration/GetBatchStatus

Required Request Parameters

Name	Location	Description
Authorization token	Header	See Login Authentication API documentation
RequestID	Body	Provided as a response to

Request Json

{ "RequestId": "5a45ec8f-deed-4335-9484-985455b8c50a" }

Response Parameters

Name	Description
RequestID	The ID will be included to differentiate the statuses on multiple requests.
RequestStatus	Possible response values are: "Successful","Failure","AwaitingProcess", "Pending","Inprocess","PartialSuccess"
Status	Confirms this is a valid RequestID
Errors	Error object providing information if an error occurs

Response Json

{
  "RequestId": "91d9ad28-8759-4ccd-b401-a4ea0c32ed19",
  "RequestStatus": "Pending",
  "RequestError": null,
  "Status": true,
  "Errors": null,
  "RefreshToken": false
}

Troubleshooting

If your response returns errors, the RequestError section will expand with additional information.

Error	Description
Login Timeout	If your user times out or is logged out due to inactivity, you will need to refresh your user token and submit the request again.
Invalid Request	The path (Equipment > Quality Control > Bagger) may be missing category, or a Resource name may not be spelled correctly. Review your syntax for easily fixed errors.
Object Reference Error	Generic error when the cause cannot be determined – email your request json file and response, environment and tenant into [email protected] for further assistance.

Example Error Response Json

{
  "RequestId": "5a45ec8f-deed-4335-9484-985455b8c50a",
  "RequestError": [
    {
      "ErrorCode": 0,
      "FieldName": null,
      "FieldValues": null,
      "ErrorMessage": "Invalid Request",
      "Header": null
    }
  ],
  "Status": true,
  "Errors": null,
  "RefreshToken": false
}