API ReferenceRequest Status

Get Status

GA
Gets the status of the request sent to the Gappify API

Path parameters

request_idUUIDRequired
Unique identifier for the request

Headers

AuthorizationstringRequired

Query parameters

error_detailsbooleanOptional

Specifies whether detailed error information should be included in the response. If omitted or set to false (default), the error_details field will not be included in the response.

pageintegerOptional

Specifies the page number for error details when the number of errors exceeds 1000. Only applicable when error_details=true.

Response

Shows the status of the response
request_idstring
The request identifier to uniquely identify the request
statusenum

Status of the request

  • IN_PROGRESS: Processing is ongoing.
  • PROCESSED: Processing completed successfully.
  • FAILED: Processing failed.
Allowed values:
entityenum
The entity related to the request.
record_countobject
Counts of records processed.
errorsstring or null

A general error message. Only present when the status is FAILED.

error_detailsobject or null

Detailed error information. Included only when error_details=true. Values are arrays of error messages.

For inbound-related errors, keys are source_system_id values.

For JE-related errors, keys are group_id values

Errors