QLqlonolink
local-file-groups

Get bulk deletion job status

Changed on

Returns the status of a bulk deletion job. The status is synced with the underlying execution on read on a best-effort basis: a finished job is normally reported as terminal (success or failure) immediately, but if the live sync fails the status may lag until the periodic reconciliation.

remaining_source_group_ids lists the groups that were not deleted, in ascending ID order. Deletion is idempotent, so a caller can simply resubmit that list. When more remain than fit in one response, remaining_truncated is true and remaining_cursor holds the last returned ID; pass it as after to fetch the next page. States in this job never change once the job is terminal, so paging is stable.

Required scope: `ingestion:manage`

get/local-file-groups/bulk-deletions/{bulk_deletion_id}

Request

  • Base URL
    https://developer.qaip.com/api/v1
  • URL
    https://developer.qaip.com/api/v1/local-file-groups/bulk-deletions/{bulk_deletion_id}
  • Auth
    API key in header x-api-key

Path parameters

bulk_deletion_idstring required

Bulk deletion job id returned by startBulkDeletion

Query parameters

afterstring

Return remaining_source_group_ids strictly greater than this ID. Use the remaining_cursor from the previous response to page through a long remainder.

Response

Successful retrieval of bulk deletion job

idstring required

The id of the bulk deletion job

status'unknown' | 'queued' | 'not_started' | 'managed' | 'starting' | 'started' | 'success' | 'failure' | 'canceling' | 'canceled' | 'deleting' | 'delete_job_failure' required

Job status

creation_timeinteger

Unix timestamp when the job was created

start_timeinteger

Unix timestamp when the job started

end_timeinteger

Unix timestamp when the job finished

total_countinteger required

Number of source groups the job was started with

deleted_countinteger required

Number of source groups deleted so far. Meaningful only once the job has reached a terminal status, so callers must gate on status rather than treating a low value as a failure.

remaining_source_group_idsstring[] required

Source groups that have not been deleted: skipped because another job held the group's lock, or failed part-way. Deletion is idempotent, so a caller can resubmit this list as-is once the job is terminal.

remaining_truncatedboolean required

True when remaining_source_group_ids was cut off because too many groups remain. Fetch the rest by passing remaining_cursor as the after query parameter.

remaining_cursorstring

The last ID in remaining_source_group_ids. Present only when remaining_truncated is true; pass it as the after query parameter to get the next page.

Changes

  • 2489c6f1a9d8Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 0375753f8ee3Revision changes
    • info

      endpoint added