Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

id
string<uuid>
required

ID da tarefa.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"0f9c1b2e-5d3a-4f8b-9c7e-1a2b3c4d5e6f"

type
enum<string>
required

Operação da tarefa, que define o formato de cada item em GET /tasks/{id}/results: phone-account.update-cost-center (centro de custo), phone-account.update-custom-fields (campos customizados), phone-account.top-up-data (recarga de dados), phone-account.cancel (cancelamento) ou employee.sync (criação ou atualização de colaboradores). Novos valores podem ser adicionados; trate um valor desconhecido sem falhar.

Available options:
phone-account.update-cost-center,
phone-account.update-custom-fields,
phone-account.top-up-data,
phone-account.cancel,
employee.sync
Example:

"phone-account.update-cost-center"

status
enum<string>
required

Situação da tarefa: running enquanto ainda há itens sendo processados, succeeded quando a alteração foi aplicada em todos os itens, failed quando terminou com ao menos um item com falha, canceled quando foi interrompida.

Available options:
running,
succeeded,
failed,
canceled
Example:

"running"

totalCount
integer
required

Quantidade de itens incluídos na tarefa.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

10

appliedCount
integer
required

Quantidade de itens em que a alteração foi aplicada.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

7

failedCount
integer
required

Quantidade de itens em que a alteração não foi aplicada.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

pendingCount
integer
required

Quantidade de itens que ainda estão sendo processados.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

2

canceledCount
integer
required

Quantidade de itens que deixaram de ser processados porque a tarefa foi interrompida.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

0