Status
Get the status of the current import operation.
It requires the run-import
permission.
URL | Requires Auth | HTTP Method |
---|---|---|
|
|
|
Headers
Argument | Example | Required | Description |
---|---|---|---|
|
| Required | The authenticated user ID. |
|
| Required | Auth token. |
Example Call
Example Result
Success
Operation States
State | Description |
---|---|
| No import operation was ever created |
| An operation was created but no data was added to it. |
| A traditional importer is currently loading data from a file to the import operation. |
| An operation was created and has data ready to import. |
| The import operation is running and the users are being created. |
| An error caused the operation to stop running. |
| The operation was interrupted by an administrator. |
| The operation was completed successfully. |
Here are some key points to note:
The operation is considered successful if it processes every user in the staging area, even if no user is imported.
You can check how many users have been imported or failed to import with the
operation.count.completed
andoperation.count.error
attributes.The data from users that failed to import will remain in the staging area after the operation is complete.
While the operation is running, the values on
operation.count
are only updated once after every 50 users are processed.
Error
No Permission: This occurs when the authenticated user doesn't have the
run-import
permission.
Change Log
Version | Description |
---|---|
| Added |
Last updated