Как использовать REST API
В настоящее время TrackStudio REST API находится в экспериментальной фазе. Мы планируем развивать этот интерфейс, поэтому структура запросов и возвращаемых данных может меняться
Структура запросов
В общем виде запросы в TrackStudio REST API имеют вид:
http://host:port/TrackStudio/rest/resource-name?paramname=value
На данный момент времени с каждым запростом через REST API требуется передавать обязательные параметры:
login - учетная запись
password - пароль
Поддерживаются следующие ресурсы
/task/tasks/{parent}
Выводит список названий фильтров, доступных в задаче {parent}
Пример использования:
Запрос: http://localhost:8888/TrackStudio/rest/task/tasks/95?login=root&password=root
Ответ:
["Все задачи (включая вложенные)","Список требований (включая вложенные)","Список требований","Открытые задачи (включая вложенные)","Открытые задачи","Мои задачи (включая вложенные)","Мои задачи","Все задачи"]
/task/tasks/{parent}/{filter}
Выводит список подзадач задачи {parent}, отфильтрованных фильтром {filter}
Пример использования:
Запрос: http://localhost:8888/TrackStudio/rest/task/tasks/96/All?login=root&password=root
Ответ:
[{"name":"Функциональные требования","id":"4028808a1951e21b0119526f85440163","number":"104","attachment":null,"description":" \n","abudget":0,"budget":0,"closedate":-1,"deadline":-1,"shortname":"","submitdate":1208268850000,"updatedate":1208286872000,"childrenCount":1,"messageCount":0,"hasAttachments":false,"onSight":true,"messages":null,"udfs":null,"categoryName":"Список требований","statusName":"Новый","resolutionName":null,"priorityName":"Нормальный","submitterName":"root","handlerUserName":"manager","handlerGroupName":null,"parentName":"Требования","workflowName":"Папка","abudgetView":"-","budgetView":"","closedateView":"","deadlineView":"","submitdateView":"15.04.08 10:14","updatedateView":"15.04.08 15:14","categoryLink":"http://localhost:8888/TrackStudio/icons/categories/default_folder.png","stateLink":"http://localhost:8888/TrackStudio/cssimages/startstate.png"},{"name":"Пользовательские требования","id":"4028808a1951e21b0119526f56e10162","number":"103","attachment":null,"description":" \n","abudget":0,"budget":0,"closedate":-1,"deadline":-1,"shortname":"","submitdate":1208268838000,"updatedate":1208286853000,"childrenCount":1,"messageCount":0,"hasAttachments":false,"onSight":true,"messages":null,"udfs":null,"categoryName":"Список требований","statusName":"Новый","resolutionName":null,"priorityName":"Нормальный","submitterName":"root","handlerUserName":"manager","handlerGroupName":null,"parentName":"Требования","workflowName":"Папка","abudgetView":"-","budgetView":"","closedateView":"","deadlineView":"","submitdateView":"15.04.08 10:13","updatedateView":"15.04.08 15:14","categoryLink":"http://localhost:8888/TrackStudio/icons/categories/default_folder.png","stateLink":"http://localhost:8888/TrackStudio/cssimages/startstate.png"},{"name":"Нефункциональные требования","id":"4028808a1951e21b0119526f2be90161","number":"102","attachment":null,"description":" \n","abudget":0,"budget":0,"closedate":-1,"deadline":-1,"shortname":"","submitdate":1208268827000,"updatedate":1208268827000,"childrenCount":0,"messageCount":0,"hasAttachments":false,"onSight":true,"messages":null,"udfs":null,"categoryName":"Список требований","statusName":"Новый","resolutionName":null,"priorityName":"Нормальный","submitterName":"root","handlerUserName":"manager","handlerGroupName":null,"parentName":"Требования","workflowName":"Папка","abudgetView":"-","budgetView":"","closedateView":"","deadlineView":"","submitdateView":"15.04.08 10:13","updatedateView":"15.04.08 10:13","categoryLink":"http://localhost:8888/TrackStudio/icons/categories/default_folder.png","stateLink":"http://localhost:8888/TrackStudio/cssimages/startstate.png"},{"name":"Бизнес требования","id":"4028808a1951e21b0119526efcca0160","number":"101","attachment":null,"description":" \n","abudget":0,"budget":0,"closedate":-1,"deadline":-1,"shortname":"","submitdate":1208268815000,"updatedate":1208268815000,"childrenCount":0,"messageCount":0,"hasAttachments":false,"onSight":true,"messages":null,"udfs":null,"categoryName":"Список требований","statusName":"Новый","resolutionName":null,"priorityName":"Нормальный","submitterName":"root","handlerUserName":"manager","handlerGroupName":null,"parentName":"Требования","workflowName":"Папка","abudgetView":"-","budgetView":"","closedateView":"","deadlineView":"","submitdateView":"15.04.08 10:13","updatedateView":"15.04.08 10:13","categoryLink":"http://localhost:8888/TrackStudio/icons/categories/default_folder.png","stateLink":"http://localhost:8888/TrackStudio/cssimages/startstate.png"}]
/task/info/{number}
Выводит информацию о задаче с номером {number}
Обязательные параметры:
login - учетная запись
password - пароль
Необязательные параметры:
message - если 'true', вместе с задачей будут выведены сообщения
attach - если 'true', вместе с задачей будут выведены вложения
udf - если 'true', будут выведены значения дополнительных полей
Примеры использования:
Запрос: http://localhost:8888/TrackStudio/rest/task/info/120?login=root&password=root
Ответ:
{"name":"Проверка страницы логин","id":"4028808a1953022d0119531c0e5500c8","number":"120","attachment":null,"description":"<p><strong>ПРЕДВАРИТЕЛЬНЫЕ ТРЕБОВАНИЯ:</strong></p>\n<p>Все задания для дизайнеров и разработчиков по работе над страницой Логин должны быть завершены. </p>\n<p><strong>ПЛАН ДЕЙСТВИЙ:</strong></p>\n<p>Откройте страницу Логин. </p>\n<p><strong>ПЛАН ПРОВЕРКИ:</strong></p>\n<p>- Окно Логин открыто<br /> - Название окна - Логин<br /> - Логотип компании отображается в правом верхнем углу <br /> - На форме 2 поля - Имя и Пароль<br /> - Кнопка Логин доступна<br /> - Линк забыл пароль - доступен </p>\n<p>- Еще нужно добавить ссылку на страницу авторегистрации.</p>\n<p>- И ссылку для входе через аннонимного пользователя.</p>","abudget":0,"budget":0,"closedate":-1,"deadline":-1,"shortname":"","submitdate":1208280157000,"updatedate":1291304234000,"childrenCount":0,"messageCount":2,"hasAttachments":false,"onSight":true,"messages":null,"udfs":null,"categoryName":"Набор тестовых данных","statusName":"Новый","resolutionName":null,"priorityName":"Обычный","submitterName":"manager","handlerUserName":"manager","handlerGroupName":null,"parentName":"Тестовая документация","workflowName":"Набор тестовых данных","abudgetView":"-","budgetView":"","closedateView":"","deadlineView":"","submitdateView":"15.04.08 13:22","updatedateView":"02.12.10 10:37","categoryLink":"http://localhost:8888/TrackStudio/icons/categories/document.png","stateLink":"http://localhost:8888/TrackStudio/cssimages/startstate.png"}
Eng