DataService API

Используйте данный веб-сервис для программного доступа к данным, хранящимся в Devprom ALM, например, с целью интеграции с другими инструментами, используемыми в работе. Все методы сервиса в качестве первого параметра принимают ключ, полученный после авторизации.


Протокол: SOAP, WebService

Ссылка: http://<host>/api/dataservice

WSDL описание (rpc/encoded): http://<host>/api/dataservice?wsdl

WSDL описание (document/literal): http://<host>/api/dataservice?wsdl&style=document&use=literal

Методы

Название Возвращаемое значение Назначение

<класс>RemoteAdd (string token.Key, <класс> object)

<класс>

Создание экземпляра <класс> с атрибутами по умолчанию, заданными в переменной object. Возвращает созданный экземпляр с заполненными полями Id и т.п.

<класс>RemoteAddBatch(string token.Key, <класс>[] objects)

<класс>

Создание экземпляров <класс> из вектора. Возвращает вектор созданных экземпляров с заполненными полями Id и т.п.

<класс>RemoteLoad (string token.Key, string id)

<класс>

Возвращает экземпляр <класс> загруженный по идентификатору id.

<класс>RemoteStore (string token.Key, string id, <класс> object)


Сохраняет атрибуты экземпляра <класс> идентифицируемого по id.

<класс>RemoteStoreBatch(string token.Key, <класс>[] objects)


Сохраняет атрибуты экземпляров типа <класс>, идентифицируемых значениями атрибутов Id.

<класс>RemoteDelete(string token.Key, string id)


Удаляет экземпляр <класс> идентифицируемый по id.

<класс>RemoteDeleteBatch(string token.Key, <класс>[] objects)


Удаляет экземпляры типа <класс>, идентифицируемых значениями атрибутов Id.

<класс>RemoteGetAll(string token.Key)

<класс>[]

Возвращает все сохраненные экземпляры <класс> в виде массива объектов.

<класс>RemoteFind (string token.Key, <класс> object)

<класс>[]

Выполняет поиск объектов по точному совпадению значений атрибутов object. Например, для поиска по названию, необходимо задать значение атрибута object.Caption и т.д. В результате возвращается массив экземпляров <класс>, удовлетворяющих критериям поиска

Классы

Название Атрибут Назначение

task

Id

Идентификатор объекта


Caption

Заголовок задачи


Priority

Идентификатор приоритета (ссылка на priority)


TaskType

Идентификатор типа задачи (ссылка на tasktype)


Release

Идентификатор итерации (спринта), в которую включена задачи (ссылка на iteration)


State

Текстовое значение текущего состояния задачи, например, submitted или resolved


Assignee

Идентификатор исполнителя (ссылка на paticipant)


ChangeRequest

Идентификатор исходного пожелания (ссылка на request)


Planned

Плановая трудоемкость по задаче в часах


LeftWork

Оставшаяся трудоемкость по задаче в часах


Fact

Фактически затраченное время на задачу в часах


Comments

Комментарий к задаче


RecordCreated

Дата и время создания задачи


RecordModified

Дата и время последней модификации задачи


Result

Текстовое значение результата выполнения задачи

priority

Id

Идентификатор объекта


Caption

Отображаемое название приоритета

tasktype

Id

Идентификатор объекта


Caption

Отображаемое название типа задачи


ReferenceName

Кодовое имя типа задачи, например, testdesign

iteration

Id

Идентификатор объекта


ReleaseNumber

Отображаемое название итерации


StartDate

Дата начала итерации


StartDate

Дата окончания итерации


IsActual

Признак актуальности итерации, "N" - итерация устарела


InitialVelocity

Начальная скорость команды для данной итерации


RecordCreated

Дата и время создания итерации


RecordModified

Дата и время последней модификации итерации

participant

Id

Идентификатор объекта


Caption

Отображаемое имя участника проекта


Email

Адрес электронной почты участника (readonly)


Login

Системное имя участника (readonly)


SystemUser

Идентификатор пользователя в системе (ссылка на user)

request

Id

Идентификатор объекта


Caption

Отображаемое имя пожелания (или истории пользователя)

requirement

Id

Идентификатор объекта


Caption

Отображаемое имя раздела требования


ParentPage

Ссылка на объект типа requirement, являющийся родительской страницей


PageType

Ссылка на объект типа wikipagetype, определяющий тип раздела требований


Content

Содержимое раздела требований

Примеры (C#)

// авторизуемся в проекте
 security.SecurityService api = new security.SecurityService() { 
      Url = 'http://<host>/api/securityservice'
 };
 data.DataService _dataService = new data.DataService() { 
      Url = 'http://<host>/api/dataservice'
 };
 
 security.Token _token = api.login("guest", "guest", "development");
 
 data.participant[] participants = _dataService.participantRemoteFind(
     _token.Key, new data.participant() { Caption = "Ivan Ivanovich" } );


Результаты поиска