Description
Please, read first https://dru-id.com/developers/apis/oauth-2/ to learn about Oauth2 protocol and the meaning of each token.
This method returns the result of the bulk operation. The response includes one entry for each user update that failed. Each returned object contains a detailed explanation describing the reason the update for that specific user could not be completed.
Two query parameters are available to control how results are retrieved:
-
limit– Specifies the maximum number of failure records to return in a single response. This acts as the batch size for pagination. -
last– A UUIDv7 cursor that indicates the position from which the next batch of results should be fetched. Cursor pagination ensures stable, efficient navigation through the dataset without the inconsistencies that occur with offset-based pagination. -
failedOnly– A boolean parameter to fetch only the errors.
The response includes a field called lastId, which represents the cursor for the next page. (See explame below).
If lastId is present, the client should pass its value back as the last query parameter in the next request to continue retrieving additional failure records.
If lastId is not present in the response, it indicates that there is no more content to fetch. The client should continue making paginated requests until a response is returned without the lastId field, which signals that all available records have been retrieved.
Endpoint URL:
GET https://{your-endpoint-domain.com}/activityid/v1/user/bulk/{bulk_id}/results
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
| Parameter | Description | Type | Required |
|---|---|---|---|
| last | The last bulk id used for the cursor pagination. If omitted it will take the first page. | string | no |
| limit | The maximum number of result to return per page. If omitted the system will get the cockpit default. | string | no |
| failedOnly | Whether to return just the errors. | boolean | no |
Response examples
Response OK
No errors for the bulk process
Bulk not found
The bulk is not finished yet
| Parameter | Description | Type |
|---|---|---|
| content | Data receive with the response | struct |
| content.bulkId | Id of the bulk process. | string |
| content.lastId | The lastId queried is neeced as a cursor for requesting the next page. Use is string as a query parameter “last” to get the next page | string |
| content.results | An array of the errors of the bulk process | struct |
| content.results.id | Id of the bulk row | string |
| content.results.userIdentifierType | The id type used for identifying the user in the request. [“object_id”, “pulse_id”] | string |
| content.results.objectId | The objectId of the user | String |
| content.results.pulseId | The pulseId of the user | String |
| content.results.error | A detailed description of the error that happens while patching that concrete user. | string |
| 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) |
| 404 | Error | Not found |
| 428 | Error | Precondition Required. The bulk process had not finished yet. |
| 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 | MFA code configured succesfully |