v1Recursos/Locations/getRead bulk edit progress

Read bulk edit progress

Returns the progress of a bulk edit started with async: true: status, total, succeeded, failed, skipped and done counts, counts per outcome code, and the locations that failed or were skipped. Only the user who started the job can read it, and a key restricted to specific clients sees only jobs started under those same clients; any other job returns 404.

get/api/v1/locations/bulk-edit-jobs/{id}
locations:read
Parâmetros de consulta
idstringobrigatório
Job ID returned by the bulk edit with async: true.
Resposta
dataobjectopcional
idstringopcional
kindstringopcional
statusstring (queued | running | canceling | completed | partial | failed | canceled)opcional
totalintegeropcional
succeededintegeropcional
failedintegeropcional
skippedintegeropcional
doneintegeropcional
codesobjectopcional
problemsarray of objectopcional
targetIdstringopcional
statusstringopcional
codestringopcional
Erros
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
503A operação exige atenção ou não pôde ser concluída.
get/api/v1/locations/bulk-edit-jobs/{id}
Sua chave de API
id *
{}

Guias que usam este recurso