Descrição
Este endpoint verifica o status atual de uma tarefa de geração de dados enviada anteriormente. Ele retorna o código de status e informações adicionais sobre a tarefa, como a quantidade de lotes (para respostas em formato JSON).
Endpoint
GET https://yourdomain.pharmahrm.com/crm-api/db-function/status/{{job_id}}
Autenticação
Bearer Token (obrigatório)
Solicitação
Cabeçalhos
| Key | Value |
|---|---|
| Authorization | Bearer <token>
|
| Content-Type |
application/json (optional) |
Parâmetro de caminho
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| job_id | integer | Sim | Identificador único da tarefa enviada |
Corpo
Não é necessário corpo na solicitação.
Resposta bem-sucedida
200 OK
{
"id": 39,
"status": 3,
"batch_count": null
}Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
| id | integer | Job ID — identificador da tarefa enviada |
| status | integer | Status atual da tarefa (consulte os códigos abaixo) |
| batch_count | integer ou null | Número de lotes de dados (aplicável apenas para JSON; um lote = 500 registros) |
Códigos de status
| Código | Status | Descrição |
|---|---|---|
| 1 | Pending (Aguardando) | A tarefa está na fila de execução |
| 2 | Running (Em execução) | A tarefa está sendo processada |
| 3 | Finished (Concluída) | A tarefa foi concluída com sucesso |
| 4 | Error (Erro) | Ocorreu um erro durante a execução |
Resposta de erro
40x / 50x
{
"message": "Error message string"
}| Código | Descrição |
|---|---|
| 400-499 | Erros do cliente (ex.: identificador inválido) |
| 500–599 | Erros do servidor |