The Standard Batch API Jobs page (found in Tools → Data Import → Standard Batch APIs) contains a historical record of all jobs sent to the product. It includes the following high-level information:
-
Identifier
- A unique ID autogenerated and attached to the job upon creation.
-
State
- The current status of the job (e.g. complete, running, dry-run, error).
-
Errors
- The number of errors encountered in the job.
-
Created
- Date and time of when the job was created.
-
Comment
- Any comments that were attached to the job when created.
By clicking on the identifier link in the table you get more details about a specific job, e.g.
- number of records processed.
- a log which includes errors (if any).
- the JSON file with the data that was submitted for this job.
API Import
The standard batch import API is useful for automated uploads, and development of scripts which automatically upload batches of files after extracting data from the external system.
There are three steps:
- Create a new batch job
- Upload the files
- Schedule the import job to run it.
You’ll need an API key, more on this here Standard Batch API: Create API Key. You will be using the generated API key for your import requests along with username haplo.
Technical documentation and example scripts can be found here: Standard batch import API
API status endpoint
The GEM Standard API offers an endpoint for checking job status. This enables users to programmatically query the status of any job at any given time:
https://{gem_base_url}/api/haplo-data-import-standard-api/status?batch={Job ID}
As a first step, you can quickly test this in your browser:
For integration automation, when initiating a new batch import job via the API, the batch ID is provided in the response. This ID is then used for subsequent /status calls to track the job's progress.