Endpoint for getting the status for inbound files

Check the processing status of a file previously uploaded to Integration Hub. This endpoint allows you to track the progress of file processing.

Status Flow

Files progress through the following states:

1. Receiving: Initial upload in progress
2. Queued: File received and waiting for processing
3. Processing: File is being validated and processed
4. WaitingInteraction: Processing paused, waiting for user input
5. PartiallySucceeded: Some records processed with errors
6. Succeeded: All records processed successfully
7. Failed: Processing failed
8. Discarded: File processing was cancelled or discarded
9. Unknown: Status cannot be determined

Response Details

Returns a JSON object containing:

• uniqueFileName: The file identifier
• status: Current processing state
• submittedTime: When the file was uploaded
• finishedTime: When processing completed (null if not finished)

Common Use Cases

• Polling for completion status
• Error checking before retry
• Monitoring processing progress

Best Practices

• Poll at reasonable intervals
• Implement exponential backoff
• Handle all possible status values

Error Responses

• 404: File not found
• 403: Insufficient permissions
• 401: Invalid authentication

Note: Files are typically processed within 5 minutes, depending on size and complexity.