API – Створення завдання для чек-листа
Для створення завдання для чек-листа потрібно надіслати POST запит на URI https://your-domain.davintoo.com/api/v2/tasks/create
- В тілі запиту має бути JSON об'єкт із параметрами завдання.
- Запит повинен містити заголовки Content-Type: application/json;charset=UTF-8 та X-Cbr-Authorization: Bearer API_TOKEN.
Приклад запиту:
curl -X POST 'https://your-domain.davintoo.com/api/v2/tasks/create'--data-raw '{"type":"check-list","element_id":977,"title":"Оцінка новачка наставником","description":"","tags":["стажування"],"threshold":85,"has_exact_time":"true","has_exact_time": false, "date_range":["2024-03-18", "2024-03-20"],"date_start":"2024-03-18","date_finish":"2024-03-20","not_block_after_expiration":true,"allow_comments":true,"reminder_enabled":true,"evaluate_type":"evaluates-tutor"}'
-H 'X-Cbr-Authorization: Bearer API_TOKEN'
-H 'Content-Type: application/json;charset=UTF-8'
| Поле | Опис параметра |
|---|---|
| type | Тип завдання |
| element_id | id чек-листа |
| title | Назва завдання |
| description | Опис завдання |
| tags | Мітки |
| threshold | Поріг проходження, в % |
| has_exact_time | Обмежити час доступу |
| date_start | Дата початку завдання |
| date_finish | Дата завершення завдання |
| not_block_after_expiration | Не закривати доступ після закінчення терміну |
| allow_comments | Дозволити коментування |
| reminder_enabled | Включити нагадування |
| evaluate_type | Режим оцінки (evaluates-tutor - оцінка куратором, self_esteem - самооцінка) |
Відповідь
В разі успішного запиту (HTTP код відповіді - 200), буде відповідь у форматі JSON з інформацією про створене завдання.
В разі помилки (HTTP код відповіді - 400) повертає JSON об'єкт з інформацією про помилку:
{"title":{"required":"Field cannot be empty"}}
Додаткові налаштування для завдання з чек-листом
Вибір режиму призначення анкет
Після створення завдання для чек-листа потрібно обрати режим призначення анкет. Для цього потрібно відправити PUT запит URI https://your-domain.davintoo.com/api/rest.php/task-check-list-settings/{taskId}, де в тілі запиту має бути JSON об'єкт з параметром assign_mode (manually - вручну, organization_structure_chiefs - керівник по структурі).
Приклад запиту:
curl -X PUT 'https://your-domain.davintoo.com/api/rest.php/task-check-list-settings/34423'--data-raw '{"assign_mode":"organization_structure_chiefs"}'
-H 'X-Cbr-Authorization: Bearer API_TOKEN'
-H 'Content-Type: application/json;charset=UTF-8'
Включення опції "Показувати результати оцінки за чек-листом оцінюваним користувачам"
Якщо завдання з чек-листом оцінює куратор та необхідно включити опцію "Показувати результати оцінки за чеклістом оцінюваним користувачам" то після створення завдання необхідно надіслати PUT запит на URI https://your-domain.davintoo.com/api/rest.php/task-check-list-settings/{taskId}, де в тілі запиту має бути JSON об'єкт show_result_to_user
Приклад запиту:
curl -X PUT 'https://your-domain.davintoo.com/api/rest.php/task-check-list-settings/34423'--data-raw '{"show_result_to_user":true}'
-H 'X-Cbr-Authorization: Bearer API_TOKEN'
-H 'Content-Type: application/json;charset=UTF-8'
