Cancelar una operación por lotes

Detén un trabajo por lotes que no ha terminado. Los ítems que aún no han iniciado se cancelan; los ítems que ya están en ejecución se permiten finalizar.

cancelBulkOperation detiene un trabajo que enviaste. Es de mejor esfuerzo e irreversible: los ítems aún en QUEUED se cancelan, mientras que los ítems ya RUNNING se permiten finalizar y registrar sus resultados. No revierte el trabajo que ya se completó.

Disponible solo en staging por el momento.

Requisitos

Authorization: Basic <API_KEY>
La capacidad de la API por lotes en tu aplicación.
El trabajo debe pertenecer a tu aplicación; un id de trabajo desconocido o de otra aplicación devuelve not-found.

Mutación

mutation CancelBulkOperation($bulkJobId: UUID!) {
  cancelBulkOperation(bulkJobId: $bulkJobId) {
    jobId
    status
    succeededItemCount
    failedItemCount
    skippedItemCount
  }
}

{
  "bulkJobId": "9c1e6f2a-1d4b-4a2e-8f0c-2b7e5a9d1234"
}

Respuesta

{
  "data": {
    "cancelBulkOperation": {
      "jobId": "9c1e6f2a-1d4b-4a2e-8f0c-2b7e5a9d1234",
      "status": "CANCELLED",
      "succeededItemCount": 4,
      "failedItemCount": 0,
      "skippedItemCount": 0
    }
  }
}

Argumentos

Parámetro	Tipo	Descripción
`bulkJobId`	`UUID!`	El id del trabajo devuelto por `submitBulkOperation`.

Campos de la respuesta

Campo	Descripción
`status`	`CANCELLED` una vez que el trabajo deja de aceptar nuevo trabajo. Los ítems que ya habían tenido éxito o fallado conservan su resultado.
`succeededItemCount` / `failedItemCount` / `skippedItemCount`	Contadores finales por ítem, incluyendo cualquier ítem que terminó después de que se efectuó la cancelación.

Errores

Error	HTTP	Cuándo
`BulkApiAccessDenied`	403	Tu aplicación no tiene la capacidad de la API por lotes.
`BulkJobNotFound`	404	El id del trabajo es desconocido o pertenece a otra aplicación (deliberadamente indistinguibles).

Cancelar un trabajo ya finalizado o ya cancelado no es un error: devuelve el trabajo sin cambios (ver abajo).

Cancel es idempotente y seguro para reintentar. Llamarlo sobre un trabajo que ya está finalizado (COMPLETED, COMPLETED_WITH_ERRORS, FAILED) o ya CANCELLED devuelve el trabajo sin cambios: nunca arroja error y nunca revierte ítems completados. Debido a que se permite finalizar los ítems en vuelo, consulta el trabajo con Rastrear un trabajo por lotes si necesitas los conteos definitivos después de cancelar.

​Requisitos

​Mutación

​Respuesta

​Argumentos

​Campos de la respuesta

​Errores

Requisitos

Mutación

Respuesta

Argumentos

Campos de la respuesta

Errores