Acompanhar uma operação longa
Diz em que ponto está uma operação disparada com 202 (fechamento do financeiro, passe de bloqueio, aprovação em lote, provisionamento de tronco): o estado, o progresso por item, o resultado e, quando falhou, o motivo. Exige a mesma permissão e o mesmo alcance da operação que a criou — sem a permissão a resposta é 403, e fora do alcance é o mesmo 404 de uma operação que não existe.
Autorização
bearer authenticatedCredencial da v3: o JWT da sessão (o mesmo da v2) ou um token pessoal dom_pat_…. A lista de escopos de cada operação diz o que ela exige: uma capacidade (agents:read), authenticated ou session-only. Segredo de máquina (X-Agent-Secret, X-API-Token, sdk_…) não é aceito.
Em: header
Escopo: authenticated
Parâmetros de caminho
Id da operação, o mesmo do cabeçalho Location da resposta 202.
uuidCorpo da resposta
application/json
application/json
curl -X GET "https://example.com/operations/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "completed_after_interruption": true, "created_at": "2019-08-24T14:15:22Z", "dealer_id": 0, "error": null, "finished_at": "2019-08-24T14:15:22Z", "kind": "billing_closing", "operation_id": "cb4ede3c-a5d1-45e3-a9d2-fe83accbce52", "progress": { "done": 0, "total": 0 }, "required_capability": "string", "result": {}, "result_location": "string", "started_at": "2019-08-24T14:15:22Z", "status": "queued", "tenant_id": 0}