Запрос на формирование данных – Proxima Research

Описание

Этот эндпоинт запускает задачу генерации данных. Запрос поддерживает необязательные параметры и позволяет получить результаты в формате JSON или CSV. Система обрабатывает запрос асинхронно и возвращает идентификатор задачи (job ID) для отслеживания.

Endpoint

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

Аутентификация

Bearer Token (обязателен)

Запрос

Заголовок

Ключ	Значение
Authorization	Bearer `<token>`
Content-Type	application/json

Тело запроса

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

Параметры

Поле	Тип	Обязателен	Описание
function	string	Так	Метод серверной части, вызываемый для генерации данных (например, `api_get_tasks`)
format	string	Так	Желаемый формат данных в ответе. Принимает значения: `json` или `csv`
arguments	objects	Ні	Необязательные параметры, необходимые для конкретных функций (например, идентификатор задачи)

Ответы

Успешный ответ

200 OK

{
  "job_id": 39
}

Поле	Тип	Описание
job_id	integer	Уникальный идентификатор отправленной задачи на генерацию данных

Используйте этот job_id, чтобы получить статус задачи и скачать результаты с помощью других endpoints

Ошибочные ответы

4xx / 5xx

{
  "message": "Error message string"
}

Код	Описание
400 - 499	Ошибки клиента (например, некорректный ввод данных)
500 - 599	Ошибки сервера

Поиск