Описание полей задач и пр

Аватара пользователя
Сергей Курносов
Сообщения: 2
Зарегистрирован: 18.03.2013 19:31

Описание полей задач и пр

05.12.2023 17:48

Используем rest api для получения данных их план фикса.
А где множь посмотреть описание всех доступных полей объектов?
Например интересуют поля задач.

Аватара пользователя
Dmitry Goncharenko
Сообщения: 4121
Зарегистрирован: 06.06.2012 13:54

Re: Описание полей задач и пр

06.12.2023 19:54

Здравствуйте, Сергей!

Для REST API у нас есть спецификация Swagger, где описаны все методы работы с REST API а также структуры данных запросов и ответов к REST API. Перейти в спецификацию можно по ссылке, но лучше это выполнять из настроек аккаунта, раздела Управление аккаунтом -> Доступ к API -> REST API - в таком случае из спецификации можно будет сразу выполнять тестовые запросы к своему аккаунту.

В спецификации есть несколько вариантов, чтоб увидеть структуру полей объектов в запросе/ответе:
1. Для всех GET методов есть список полей, которые можно запросить в параметре fields (доступных полей объекта):
Изображение

2. В каждом методе в описании ответа/запроса есть структура данных ответа/запроса - схема, где отражены все поля:
Изображение

3. В самом низу есть модели объектов ответов/запросов:
Изображение

Ответить