Деректерді генерациялауға арналған сұраныс – Proxima Research Qazaqstan

Сипаттама

Бұл endpoint деректерді генерациялау тапсырмасын іске қосады. Сұраныс қосымша параметрлерді қолдайды және нәтижелерді 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	Иә	Деректер генерациясына арналған backend әдісі (мыс.: api_get_tasks)
format	string	Иә	Жауап форматы: json немесе csv
arguments	objects	Жоқ	Нақты функцияларға қажетті қосымша параметрлер

Жауаптар

Сәтті жауап

200 OK

{
  "job_id": 39
}

Өріс	Түрі	Сипаттамасы
job_id	integer	Деректер генерациясына жіберілген тапсырманың бірегей идентификаторы

Бұл job_id арқылы тапсырма күйін тексеріп, нәтижелерді басқа endpoint-тер арқылы жүктей аласыз.

Қателер

4xx / 5xx

{
  "message": "Error message string"
}

Код	Сипаттамасы
400 - 499	Клиент қателері (мыс.: енгізу қатесі)
500 - 599	Сервер қателері

Search