Запит на формування даних – Proxima Research Ukraine

Опис

Цей ендпоінт запускає задачу генерації даних. Запит підтримує необов’язкові параметри та дозволяє отримати результати у форматі 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	Помилки з боку сервера

Пошук