local-file-groups

Get chunk deletion job status

Changed on

Returns the status of a chunk deletion job previously started for the source group. 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.

Required scope: `ingestion:manage`

get/local-file-groups/{id}/chunk-deletions/{chunk_deletion_id}

Request

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

Path parameters

idstring required

Source group ID

chunk_deletion_idstring required

Chunk deletion job id returned by startChunkDeletion

Response

Successful retrieval of chunk deletion job

idstring required

The id of the chunk deletion job

source_group_idstring required

The ID of the source group whose chunks are being deleted

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

Job status

text_containsstring[] required

The substrings used to match chunk rows for deletion

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

deleted_countinteger required

Number of chunk rows deleted. Always present; meaningful only once the job has succeeded (status = success). Before then it is 0 (not yet determined), so callers must gate on status rather than treating 0 as "no chunks deleted".

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