How to check for errors while mass importing users with batch API?

Issue

• We are using http://localhost:8080/o/headless-admin-user/v1.0/user-accounts/batch to mass import users.
• We receive a HTTP code 202 in return indicating that the request is sent and being processed.
• How to check for possible errors during the process?

 

Environment

• Quarterly Releases

 

Resolution

• Every time you send a batch import, the response is a 202 and it contains an ID.
• To know the progress and the result with the logs, you have to call to this endpoint using the ID from the previous call.
• Please find a step by step example below:
  
  • Start the import call.
  • Copy the ID from the 202 response message (for instance: "id": 201)
  • With this ID, you have to go to the Import Batch Engine endpoints to see the result: Get Info: http://localhost:8080/o/headless-batch-engine/v1.0/import-task/201 (the last number is the ID of the execution in the previous one).

 

Additional Information

• You can set the "importStrategy" with the "ON_ERROR_FAIL" and the "ON_ERROR_CONTINUE" parameters.
• You need to send this parameter in the query: http://localhost:8080/o/headless-admin-user/v1.0/user-accounts/batch?importStrategy=ON_ERROR_CONTINUE
• If you select "ON_ERROR_FAIL", the process will stop if there's any failure and log the first error only.
• If you select "ON_ERROR_CONTINUE", in the "failedItems": [] you will have all errors instead of the first one only.