API – Звіт з програм – База знань LMS Collaborator

Головна/Технічні вимоги/Робота з API/API - Звіт з програм

API – Звіт з програм

Для авторизації використовуйте АРІ token. Детально в статті API token

Для отримання звіту з програми потрібно надіслати GET запит на URI https://your-domain.davintoo.com/api/v2/programs/report/{id}?page=1&count=10&filter[programId]={id}&sorting[task_finish_date]=desc
Запит повинен містити заголовки Content-Type: application/json;charset=UTF-8 та X-Cbr-Authorization: Bearer API_TOKEN.

Приклад запиту:

curl 'https://your-domain.davintoo.com/api/v2/programs/report/904?page=1&count=10&filter[programId]=904&sorting[task_finish_date]=desc' -H 'X-Cbr-Authorization: Bearer API_TOKEN' -H 'Content-Type: application/json;charset=UTF-8'

Замість локальної адреси https://your-domain.davintoo.com потрібно використовувати адресу вашого інстанса.
Замість 904 вказати id програми.

Запит підтримує фільтрацію по наступним полям:
taskId - ID завдання
userId - ID користувача
position - Посада
city - Місто
department - Підрозділ
tags - Мітка
task_finish_date - Період за датою завершення

Відповідь

В разі успішного запиту (HTTP код відповіді - 200), буде повернено результат виду:

data - масив результатів
pager - об'єкт пагінації (інформація про кількість сторінок, поточну сторінку, к-ть результатів)

В разі помилки (HTTP код відповіді - 400) повертає JSON об'єкт з інформацією про помилку