Solicitação para geração de dados – Proxima Research Brazil

Descrição

Este endpoint inicia uma tarefa de geração de dados. A solicitação suporta parâmetros opcionais e permite receber resultados nos formatos JSON ou CSV. O sistema processa a solicitação de forma assíncrona e retorna um identificador de tarefa (job ID) para acompanhamento.

Endpoint

POST https://yourdomain.pharmahrm.com/crm-api/db-function/run

Autenticação

Bearer Token (obrigatório)

Solicitação

Cabeçalhos

Chave	Valor
Authorization	Bearer `<token>`
Content-Type	application/json

Corpo da solicitação

{
  "function": "api_get_tasks",
  "format": "csv",
  "arguments": {
    "id": "123"
  }
}

Parâmetros

Campo	Tipo	Obrigatório	Descrição
function	string	Sim	Método do backend chamado para gerar os dados (por exemplo, api_get_tasks)
format	string	Sim	Formato desejado da resposta: json ou csv
arguments	objects	Não	Parâmetros opcionais necessários para funções específicas (por exemplo, o ID da tarefa)

Respostas

Resposta bem-sucedida

200 OK

{
  "job_id": 39
}

Campo	Tipo	Descrição
job_id	integer	Identificador único da tarefa enviada para geração de dados

Use este job_id para obter o status da tarefa e baixar os resultados usando outros endpoints.

Erros

4xx / 5xx

{
  "message": "Error message string"
}

Código	Descrição
400 - 499	Erros do cliente (ex.: entrada inválida)
500 - 599	Erros do servidor

Pesquisa