Skip to main content
↓ Download as Markdown

Reporting progress

While a job is running, progress updates may be sent to Future Ordering to allow better monitoring of import flows.

Progress​

Use the progress report API to provide status updates while your job is running. Progress updates are informational and do not affect the import - they are shown when monitoring the run in Navigator.

Example request body:

{
	...
	"status": "LOADING",
	"information": "Loaded 250 of 1000 entities."
}

Available statuses: STARTED, RUNNING, LOADING, DOWNLOADING, TRANSFERRING, PATCHING, MERGING, WAITING, SUCCESS, WARNING.

Complete​

Use the complete report API to report that your job has finished successfully.

Example request body:

{
	...
	"data": {
		"<entityId>": {
			"references": ["..."],
			"dataSources": ["..."],
			"route": "https://..."
		}
	},
	...
}
  • data — The output of your processing, keyed by entity identifier. If there are more steps in the flow, this is what the next step receives as input.

Error​

Use the error report API to report that your job has encountered an unrecoverable error. Creating an error report stops the flow.

Example request body:

{
	...
	"error": {
		"code": "IMPORT_FAILED",
		"message": "Unable to connect to source system."
	}
}