Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /config/event_sources/log_source_management/ log_source_bulk_tasks/{id}

Retrieves a log source bulk task by ID.

Table 1: GET /config/event_sources/log_source_management/log_source_bulk_tasks/{id} Resource Details

MIME Type

application/json

Table 2: GET /config/event_sources/log_source_management/log_source_bulk_tasks/{id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

id

path

Required

String

text/plain

The ID of the log source bulk task to retrieve.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: GET /config/event_sources/log_source_management/log_source_bulk_tasks/{id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The log source bulk task was retrieved successfully.

404

1001

The log source bulk task ID was not found.

Response Description

The log source bulk task. A log source bulk task contains the following fields:

  • id - String - The ID of the bulk task.

  • status - Enum - Indicates the status of the bulk task. Possible values are: IN_PROGRESS, COMPLETED_SUCCESSFULLY, COMPLETED_WITH_ERRORS, CANCELLING, CANCELLED.

  • operation_statuses - Array - An array of LogSourceBulkOperationStatus. The size and order of this list matches the list of Log Source DTOs that were passed to the bulk endpoint.

A LogSourceBulkOperationStatus contains the following fields:

  • log_source_id - Integer - The ID of the log source being operated on.

  • operation_type - Enum - The type of operation. Possible values are: CREATE, UPDATE, DELETE.

  • http_status - Integer - The HTTP status of the operation. This will be null until the operation completes.

  • message - String - The error message. This will only be set if the operation fails, otherwise it will be null.

  • unique_code - Integer - The unique error code. This will only be set if the operation fails, otherwise it will be null.

Response Sample