Объявления
Облачный Pyrus
Безоблачный Pyrus
Методы
- GET/announcements/{id}Получение объявления
- GET/announcementsПолучение списка объявлений
- POST/announcementsСоздание объявления
- POST/announcements/{id}/commentsДобавление комментария в объявление
GET /announcements/{id}
Получение объявления.
GET https://api.pyrus.com/v4/announcements/11611
Тело ответа
{ "announcement": { "id": 14786, "text": "New announcement", "formatted_text": "New announcement", "create_date": "2022-04-27T10:51:50Z", "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob.Smith@gmail.com", "type": "user", "external_id": "", "department_id": 13836, "banned": false }, "comments": [ { "id": 29662, "text": "Comment", "formatted_text": "Comment", "create_date": "2022-04-27T10:51:50Z", "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob.Smith@gmail.com", "type": "user", "external_id": "", "department_id": 13836, "banned": false } } ] } }
curl
curl -X GET \ 'https://api.pyrus.com/v4/announcements/11611' \ -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \ -H 'Content-Type: application/json'
GET /announcements
Получение списка объявлений.
GET https://api.pyrus.com/v4/announcements
Тело ответа
{ "announcements": [ { "id": 14786, "text": "Old announcement", "formatted_text": "Old announcement", "create_date": "2022-04-27T10:51:50Z", "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob.Smith@gmail.com", "type": "user", "external_id": "", "department_id": 13836, "banned": false }, "comments": [ { "id": 29662, "text": "Comment", "formatted_text": "Comment", "create_date": "2022-04-27T10:51:50Z", "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob.Smith@gmail.com", "type": "user", "external_id": "", "department_id": 13836, "banned": false } } ] }, { "id": 14787, "text": "New announcement", "formatted_text": "New announcement", "create_date": "2022-04-27T10:51:50Z", "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob.Smith@gmail.com", "type": "user", "external_id": "", "department_id": 13836, "banned": false }, "comments": [ { "id": 29662, "text": "Comment", "formatted_text": "Comment", "create_date": "2022-04-27T10:51:50Z", "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob.Smith@gmail.com", "type": "user", "external_id": "", "department_id": 13836, "banned": false } } ] } ] }
curl
curl -X GET \ 'https://api.pyrus.com/v4/announcements' \ -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \ -H 'Content-Type: application/json'
POST /announcements
Создание объявления. Метод возвращает созданное объявление.
POST https://api.pyrus.com/v4/announcements
Тело запроса
{ "text": "New announcement", }
Тело ответа
{ "announcement": { "id": 14786, "text": "New announcement", "formatted_text": "New announcement", "create_date": "2022-04-27T10:51:50Z", "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob.Smith@gmail.com", "type": "user", "external_id": "", "department_id": 13836, "banned": false } } }
curl
curl -X POST \ https://api.pyrus.com/v4/announcement/ \ -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \ -H 'Content-Type: application/json' \ -d '{ "text": "New announcement" }'
Параметры
text * | Текст объявления. |
attachments | См. формат значений параметра attachments метода создания задачи или метода добавления комментария. |
* Поле обязательно для заполнения.
POST /announcements/{id}/comments
Добавление комментария к объявлению. Метод возвращает объявление со всеми комментариями, включая добавленный.
POST https://api.pyrus.com/v4/announcements/11613 /comments
Тело запроса
{ "text": "It's done." }
Тело ответа
{ "announcement": { "id": 14786, "text": "New announcement", "formatted_text": "New announcement", "create_date": "2022-04-27T10:51:50Z", "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob.Smith@gmail.com", "type": "user", "external_id": "", "department_id": 13836, "banned": false }, "comments": [ { "id": 29662, "text": "Comment", "formatted_text": "Comment", "create_date": "2022-04-27T10:51:50Z", "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob.Smith@gmail.com", "type": "user", "external_id": "", "department_id": 13836, "banned": false } } ] } }
curl
curl -X POST \ https://api.pyrus.com/v4/announcements/11613/comments \ -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \ -H 'Content-Type: application/json' \ -d '{ "text": "It's done." }'
Параметры
В комментарии к объявлению необходимо заполнить хотя бы одно из приведенных ниже полей. В объявлении будут изменены только значения полей, которые вы передали в запросе.
text | Текст комментария. |
formatted_text | Текст комментария, содержащий форматирование html. |
attachments | См. формат значений параметра attachments метода создания задачи или метода добавления комментария. |