Description
Please, read first https://dru-id.com/developers/apis/oauth-2/ to learn about Oauth2 protocol and the meaning of each token.
Retrieve the status of a specific bulk process by providing its corresponding bulk ID. This method returns detailed information about the current state and progress of the operation.
The bulk process can transition through several distinct statuses, each representing a specific stage in its lifecycle. The possible values are:
-
received – The system has successfully accepted the bulk request through the REST API. At this stage, no processing has begun; the request has merely been acknowledged.
-
scheduled – The request has been divided into chunks and stored in the database. It is now waiting to be picked up and processed by the queue system.
-
processing – The queue has started executing the bulk operation. The system is actively working through the data and performing the required actions.
-
completed – The bulk process has finished successfully. All operations were carried out without errors, and the final results are available (until they expire based on the configured retention period).
-
failed – The bulk process encountered a fatal error that prevented it from completing. The system has halted execution, and the final status reflects this failure.
Endpoint URL:
GET https://{your-endpoint-domain.com}/activityid/v1/user/bulk/{bulk_id}
Headers
| Parameter | Description | Type | Required |
|---|---|---|---|
| Authorization | “Bearer app_token” Literal text Bearer followed by app_token that is the token obtained from /oauth2/token endpoint | string | yes |
| Content-Type | The type of content that will be used for requests to be JSON | string | yes |
| Accept | The type of content that will be used for responses to be JSON | string | yes |
| Accept-Language | Language for this request | Locale | no |
Query string parameters
None
Response examples
Response OK
Bulk not found
| Parameter | Description | Type |
|---|---|---|
| content | Data receive with the response. A single object with a bulk status. | struct |
| content.bulkId | Id of the bulk process. | string |
| content.status | Current state of the bulk process. | string |
| content.createdOn | Creation date. | string |
| content.updatedOn | Last update. The instant when the last status change was performed. | string |
| content.progress | Percentage of completion | int |
| content.remaining | An estimate of the remaining time to complete the bulk process | Period |
| result | Common http result | struct |
| result.status | Http code | integer |
| result.message | A description that describes the result of the operation | string |
Response codes
| Code | Type | Description |
|---|---|---|
| 400 | Error | Bad Request: The request could not be understood by the server due to malformed syntax |
| 401 | Error | Unauthorized: authentication is required and has failed or has not yet been provided (token is invalid, etc) |
| 500 | Error | Internal Server Error: The server encountered an unexpected condition which prevented it from fulfilling the request |
| 504 | Error | Gateway TimeoutService can not contact with oauth server to do some internal operations |
| 200 | Success | Return the bulk status of the process. |