Руководство по API веб-сервиса

Parabuild 4.4

Руководство по API веб-сервиса

Copyright © 2017 Parabuild CI

Содержание

Предисловие

1. Об Этом Руководстве

2. аудитория

3. Техническая Поддержка

1. доступ к API веб-сервиса

1.1. веб-сервис WSDL

1.2. URL-адрес веб-службы

1.3. аутентификация и авторизация

2. API веб-сервиса

2.1. Запрос Системной Информации

2.1.1. Получение Версии Сервера

2.1.2. Запрос Системных Свойств

2.1.3. перечисление глобального контроля версий пользователя на электронную карту

2.1.4. Листинг Проектов

2.1.5. Получение Атрибутов Проекта

2.1.6. Получение Конфигураций Сборки Проекта

2.1.7. Перечисление Групп Отображения

2.1.8. получение конфигураций сборки, принадлежащих группе отображения

2.2. запрос сборочных ферм и агентов

2.2.1. Перечисление Конфигураций Фермы Сборки

2.2.2. Получение Атрибутов Фермы Сборки

2.2.3. Получение Агентов Фермы Сборки

2.2.4. Конфигурации Листинговых Агентов

2.2.5. Получение Конфигурации Агента

2.2.6. Статусы Листинговых Агентов

2.3. Запрос Конфигурации Сборки

2.3.1. Перечисление Активных Конфигураций Сборки

2.3.2. Получение Атрибутов Конфигурации Сборки

2.3.3. Получение Настроек Контроля Версий

2.3.4. Получение Свойств Расписания

2.3.5. Получение Свойств Этикетки

2.3.6. Получение Конфигураций Журналов

2.3.7. Получение Свойств Конфигурации Журнала

2.3.8. получение контроля версий пользователя на электронную почту Map

2.3.9. Получение Билд-Наблюдателей

2.3.10. Получение Шагов Сборки

2.3.11. Получение Элементов Расписания

2.3.12. Получение Трекеров Выдачи

2.3.13. Получение Свойств Отслеживания Проблем

2.3.14. Получение Стартовых Параметров

2.4. Доступ К Результатам Сборки

2.4.1. получение количества запусков сборки

2.4.2. Получение Запуска Сборки

2.4.3. Запрос Завершенных Запусков Сборки

2.4.4. Получение Последнего Успешного Запуска Сборки

2.4.5. поиск последних успешных запусков сборки по идентификатору группы отображения и номеру списка изменений

2.4.6. Получение Атрибутов Запуска Сборки

2.4.7. получение списков изменений в заданном ходе сборки

2.4.8. Получение Изменений Списка Изменений

2.4.9. Получение Выполнения Шага Сборки

2.4.10. Получение Атрибутов Выполнения Шага

2.4.11. Получение Журналов Этапов Сборки

2.4.12. Получение Результатов Этапа Сборки

2.4.13. Получение Списка Изменений

2.4.14. Получение Примечаний К Выпуску

2.4.15. Получение Выпуска

2.4.16. Получение Атрибутов Выпуска

2.4.17. Получение Списков Изменений Выпуска

2.4.18. Запрос Групп Результатов

2.4.19. Запрос Групп Результатов Проекта

2.4.20. Получение Результирующих Конфигураций

2.4.21. Получение Свойств Конфигурации Результата

2.4.22. Получение Опубликованных Результатов Этапа Сборки

2.4.23. Получение Действий По Запуску Сборки

2.4.24. Запрос Имен Наборов Тестов

2.4.25. Получение имен тестовых наборов

2.4.26. Получение Тестов Build Run

2.5. Запрос Статистики Сборки

2.5.1. Запрос Почасовой Статистики Сборки

2.5.2. Запрос Ежедневной Статистики Сборки

2.5.3. Запрос Ежемесячной Статистики Сборки

2.5.4. Запрос Годовой Статистики Сборки

2.5.5. Запрос Почасового Распределения Сборки

2.5.6. Запрос Дистрибутива Сборки По Будням

2.5.7. Запрос Ежечасной Статистики Тестов

2.5.8. Запрос Ежедневной Статистики Тестов

2.5.9. Запрос Ежемесячной Статистики Тестов

2.6. Управление Сборками

2.6.1. Начало Сборки

2.6.2. Остановка Сборки

2.6.3. Возобновление Сборки

2.6.4. Запрос Чистой Проверки

2.6.5. Перечисление Текущих Статусов Сборки

2.6.6. Поиск текущего состояния сборки по идентификатору сборки

2.6.7. Поиск текущего состояния сборки по имени сборки

2.6.8. Поиск текущих статусов сборки по регулярному выражению

2.6.9. Изменение Настроек Контроля Версий

2.6.10. Изменение Последовательности Сборки

2.6.11. Изменение Настроек Расписания

Список таблиц

2.1.

2.2.

Предисловие

Содержание

1. Об Этом Руководстве

2. аудитория

3. Техническая Поддержка

Об Этом Руководстве

Данное руководство содержит описание API веб-службы Parabuild.

Аудитория

Это руководство предназначено для инженеров-программистов.

Техническая Поддержка

Если у вас возникли какие-либо проблемы с программным обеспечением или документацией, пожалуйста, свяжитесь со службой технической поддержки через онлайн-форумы поддержки, электронную почту, факс или как описано ниже. Для получения дополнительной информации о другой поддержке перейдите по ссылке поддержка на веб -сайте по адресуwww.parabuildci.org.

Форум Поддержки:

http://forums.parabuildci.org/viewforum.php?f=1

Электронная Почта:

[e-mail]

Факс:

650-240-4455

Содержание

1.1. веб-сервис WSDL

1.2. URL-адрес веб-службы

1.3. аутентификация и авторизация

Веб-сервис WSDL

Веб-сервис Parabuild WSDL можно найти по адресу:

<Каталог установки Parabuild>/bin/wsdl/Parabuild.wsdl<каталог установки Parabuild>.

URL-адрес веб-службы

Веб-сервис Parabuild доступен по адресу:

http: / / <parabuild host>: 8080 / parabuild / integration/webservice/Parabuild

Глава 2. API веб-службы

Содержание

2.1. Запрос Системной Информации

2.1.1. Получение Версии Сервера

2.1.2. Запрос Системных Свойств

2.1.3. перечисление глобального контроля версий пользователя на электронную карту

2.1.4. Листинг Проектов

2.1.5. Получение Атрибутов Проекта

2.1.6. Получение Конфигураций Сборки Проекта

2.1.7. Перечисление Групп Отображения

2.1.8. получение конфигураций сборки, принадлежащих группе отображения

2.2. запрос сборочных ферм и агентов

2.2.1. Перечисление Конфигураций Фермы Сборки

2.2.2. Получение Атрибутов Фермы Сборки

2.2.3. Получение Агентов Фермы Сборки

2.2.4. Конфигурации Листинговых Агентов

2.2.5. Получение Конфигурации Агента

2.2.6. Статусы Листинговых Агентов

2.3. Запрос Конфигурации Сборки

2.3.1. Перечисление Активных Конфигураций Сборки

2.3.2. Получение Атрибутов Конфигурации Сборки

2.3.3. Получение Настроек Контроля Версий

2.3.4. Получение Свойств Расписания

2.3.5. Получение Свойств Этикетки

2.3.6. Получение Конфигураций Журналов

2.3.7. Получение Свойств Конфигурации Журнала

2.3.8. получение контроля версий пользователя на электронную почту Map

2.3.9. Получение Билд-Наблюдателей

2.3.10. Получение Шагов Сборки

2.3.11. Получение Элементов Расписания

2.3.12. Получение Трекеров Выдачи

2.3.13. Получение Свойств Отслеживания Проблем

2.3.14. Получение Стартовых Параметров

2.4. Доступ К Результатам Сборки

2.4.1. получение количества запусков сборки

2.4.2. Получение Запуска Сборки

2.4.3. Запрос Завершенных Запусков Сборки

2.4.4. Получение Последнего Успешного Запуска Сборки

2.4.5. поиск последних успешных запусков сборки по идентификатору группы отображения и номеру списка изменений

2.4.6. Получение Атрибутов Запуска Сборки

2.4.7. получение списков изменений в заданном ходе сборки

2.4.8. Получение Изменений Списка Изменений

2.4.9. Получение Выполнения Шага Сборки

2.4.10. Получение Атрибутов Выполнения Шага

2.4.11. Получение Журналов Этапов Сборки

2.4.12. Получение Результатов Этапа Сборки

2.4.13. Получение Списка Изменений

2.4.14. Получение Примечаний К Выпуску

2.4.15. Получение Выпуска

2.4.16. Получение Атрибутов Выпуска

2.4.17. Получение Списков Изменений Выпуска

2.4.18. Запрос Групп Результатов

2.4.19. Запрос Групп Результатов Проекта

2.4.20. Получение Результирующих Конфигураций

2.4.21. Получение Свойств Конфигурации Результата

2.4.22. Получение Опубликованных Результатов Этапа Сборки

2.4.23. Получение Действий По Запуску Сборки

2.4.24. Запрос Имен Наборов Тестов

2.4.25. Получение имен тестовых наборов

2.4.26. Получение Тестов Build Run

2.5. Запрос Статистики Сборки

2.5.1. Запрос Почасовой Статистики Сборки

2.5.2. Запрос Ежедневной Статистики Сборки

2.5.3. Запрос Ежемесячной Статистики Сборки

2.5.4. Запрос Годовой Статистики Сборки

2.5.5. Запрос Почасового Распределения Сборки

2.5.6. Запрос Дистрибутива Сборки По Будням

2.5.7. Запрос Ежечасной Статистики Тестов

2.5.8. Запрос Ежедневной Статистики Тестов

2.5.9. Запрос Ежемесячной Статистики Тестов

2.6. Управление Сборками

2.6.1. Начало Сборки

2.6.2. Остановка Сборки

2.6.3. Возобновление Сборки

2.6.4. Запрос Чистой Проверки

2.6.5. Перечисление Текущих Статусов Сборки

2.6.6. Поиск текущего состояния сборки по идентификатору сборки

2.6.7. Поиск текущего состояния сборки по имени сборки

2.6.8. Поиск текущих статусов сборки по регулярному выражению

2.6.9. Изменение Настроек Контроля Версий

2.6.10. Изменение Последовательности Сборки

2.6.11. Изменение Настроек Расписания

Запрос Системной Информации

Получение Версии Сервера

/** * Возвращает версию сервера. * * @возвращает строку, содержащую версию сервера. */ Строка serverVersion();

Запрос Системных Свойств

/** * Возвращает список глобальных системных свойств. * * @возвращает список свойств глобальной системы. */ SystemProperty[] getSystemProperties();

Листинг Проектов

/** * Возвращает список проектов. * * @возвращает список проектов. */ Project [] getProjects();

Получение Атрибутов Проекта

/** * Возвращает список атрибутов проекта. * * @ param projectID идентификатор проекта * * @возвращает список атрибутов проекта. */ ProjectAttribute[] getProjectAttributes(int projectID);

Конфигурации Листинговых Агентов

/** * Возвращает список конфигураций агента. * * @ возвращает список конфигураций агента. */ AgentConfiguration [] getAgentConfigurations();

Статусы Листинговых Агентов

 /** * Возвращает список статусов агента. * * Код статуса агента содержится в поле "Статус". 1 означает отключен. 2 означает простоя. * 3 означает занят. 4 означает офлайн. 5 означает, что существует несоответствие версий. * * @ возвращает список статусов агента. */ AgentStatus[] getAgentStatuses();

Запрос Конфигурации Сборки

В этом разделе перечисляются методы запроса информации, связанной с конфигурацией сборки.

Получение Свойств Этикетки

/** * Возвращает список свойств метки. * * @ param buildID build ID * @возвращает список свойств метки. */ LabelProperty[] getLabelProperties(int buildID);

Получение Билд-Наблюдателей

/** * Возвращает список наблюдателей сборки. * * @param buildID список наблюдателей сборки. * @возвращает список наблюдателей сборки. */ BuildWatcher [] getBuildWatchers(int buildID);

Получение Шагов Сборки

/** * Возвращает список шагов сборки. * * @ param buildID build ID * @возвращает список шагов сборки. */ BuildSequence[] getBuildSequence(int buildID);

Получение Трекеров Выдачи

Доступ К Результатам Сборки

В этом разделе перечислены методы доступа к результатам сборки.

Получение Запуска Сборки

/** * Возвращает запуск сборки для данного идентификатора запуска сборки. * * @ param buildRunID build run ID * @return build run. */ BuildRun getBuildRun (int buildRunID);

Получение Списка Изменений

/** * Возвращает список изменений. * * @ param changeListID идентификатор списка изменений * @возврат списка изменений. */ ChangeList getChangeList (int changeListID);

Получение Выпуска

/** * Возвращает проблему. * * @param issueID идентификатор проблемы. * @возврат проблемы. */ Выпуск getIssue(int issueID);

Получение Атрибутов Выпуска

/** * Возвращает список атрибутов проблемы. * * @ param issueID идентификатор выпуска. * * @возвращает список атрибутов проблемы. */ IssueAttribute[] getIssueAttributes(int issueID);

Запрос Групп Результатов

/** * Возвращает список групп результатов. * * @return список групп результатов. */ ResultGroup[] getResultGroups();

Запрос Имен Наборов Тестов

/** * Возвращает список имен наборов тестов. * * @возвращает список имен наборов тестов. */ TestSuiteName[] getTestSuiteNames();

Получение Тестов Build Run

/** * Возвращает список тестов выполнения сборки. * * @ param buildRunID build run ID * * @возвращает список тестов выполнения сборки. */ BuildRunTest[] getBuildRunTests(int buildRunID);

Запрос Статистики Сборки

Управление Сборками

Начало Сборки

/** * Запускает сборку. * * @ param activeBuildID идентификатор сборки для запуска. * /void startBuild(int activeBuildID); /** * Запускает сборку. * * @ param activeBuildID идентификатор сборки для запуска. * @param buildStartRequest объект, содержащий подробный запрос на запуск сборки. * /void startBuild(int activeBuildID, BuildStartRequest buildStartRequest) вызывает исключение IOException;

BuildStartRequest

BuildStartRequest имеет следующий формат:

Таблица 2.1.

Имя Поля	Описание
requestType	Целочисленный тип запроса. 0 означает, что это обычный запрос. Обычный запрос начинает сборку с самого последнего номера списка изменений. 1 означает, что это повторный запуск сборки. Для повторного запуска сборки необходимо установить buildRunID.
чистая проверка	Логический флаг чистой проверки. Если установлено значение true, Parabuild очистит рабочую область сборки перед запуском сборки.
pinResult	Логический флаг результата pin-кода. Если установлено значение true, результаты сборки будут закреплены.
buildRunID	Идентификатор запуска сборки для повторного запуска. Если это не повторный запрос, buildRunID должен быть установлен в значение -1.
changeListID	Целочисленный номер списка изменений. Номер списка изменений можно использовать для запуска ручной сборки по определенному номеру списка изменений. Номер списка изменений поддерживается для Perforce и Subversion.
userID	Целочисленный идентификатор пользователя, который запускает сборку. Если он неизвестен, то идентификатор пользователя должен быть установлен в значение -1.
счетчик версий	Счетчик версий строк. Если не известно, то должна быть установлена пустая строка.
этикетка	Строковая метка, которую Parabuild должен применить к системе управления версиями, если сборка прошла успешно. Метка должна быть установлена в пустую строку, если метка не должна быть применена.
записка	Примечание, которое Parabuild должен добавить к сборке. Примечание должно быть установлено в пустую строку, если примечание не должно быть добавлено.
versionTemplate	Шаблон Строковой версии Parabuild должен использоваться для создания версии продукта. Шаблон версии должен быть установлен в пустую строку, если версия продукта не должна быть сгенерирована.
список параметров	Список параметров начала сборки. Пожалуйста, ознакомьтесь с описанием BuildStartRequestParameter объект для получения информации.

BuildStartRequestParameter

BuildStartRequestParameter имеет следующий формат:

Таблица 2.2.

Имя Поля	Описание
переменное имя	Строковое имя переменной оболочки, устанавливаемое перед выполнением команд сборки
переменные значения	Строка, разделенная запятыми, список одного или нескольких значений переменной
Описание	Описание строковой переменной

Остановка Сборки

/** * Останавливает сборку. * * @ param activeBuildID идентификатор сборки для остановки. * /void stopBuild(int activeBuildID);

Возобновление Сборки

/** * Возобновляет ранее остановленную сборку. * * @ param activeBuildID идентификатор сборки для возобновления. * /void resumeBuild(int buildID);

Запрос Чистой Проверки

/** * Запросы на чистую проверку. Parabuild сотрет рабочее пространство сборки перед запуском следующейсборки. * * @param activeBuildID идентификатор сборки для того, чтобы выполнить чистую проверку. * /void requestCleanCheckout(int activeBuildID);

Parabuild 4.4

Руководство по API веб-сервиса

Copyright © 2017 Parabuild CI

Содержание

Предисловие

1. Об Этом Руководстве

2. аудитория

3. Техническая Поддержка

1. доступ к API веб-сервиса

1.1. веб-сервис WSDL

1.2. URL-адрес веб-службы

1.3. аутентификация и авторизация

2. API веб-сервиса

2.1. Запрос Системной Информации

2.1.1. Получение Версии Сервера

2.1.2. Запрос Системных Свойств

2.1.3. перечисление глобального контроля версий пользователя на электронную карту

2.1.4. Листинг Проектов

2.1.5. Получение Атрибутов Проекта

2.1.6. Получение Конфигураций Сборки Проекта

2.1.7. Перечисление Групп Отображения

2.1.8. получение конфигураций сборки, принадлежащих группе отображения

2.2. запрос сборочных ферм и агентов

2.2.1. Перечисление Конфигураций Фермы Сборки

2.2.2. Получение Атрибутов Фермы Сборки

2.2.3. Получение Агентов Фермы Сборки

2.2.4. Конфигурации Листинговых Агентов

2.2.5. Получение Конфигурации Агента

2.2.6. Статусы Листинговых Агентов

2.3. Запрос Конфигурации Сборки

2.3.1. Перечисление Активных Конфигураций Сборки

2.3.2. Получение Атрибутов Конфигурации Сборки

2.3.3. Получение Настроек Контроля Версий

2.3.4. Получение Свойств Расписания

2.3.5. Получение Свойств Этикетки

2.3.6. Получение Конфигураций Журналов

2.3.7. Получение Свойств Конфигурации Журнала

2.3.8. получение контроля версий пользователя на электронную почту Map

2.3.9. Получение Билд-Наблюдателей

2.3.10. Получение Шагов Сборки

2.3.11. Получение Элементов Расписания

2.3.12. Получение Трекеров Выдачи

2.3.13. Получение Свойств Отслеживания Проблем

2.3.14. Получение Стартовых Параметров

2.4. Доступ К Результатам Сборки

2.4.1. получение количества запусков сборки

2.4.2. Получение Запуска Сборки

2.4.3. Запрос Завершенных Запусков Сборки

2.4.4. Получение Последнего Успешного Запуска Сборки

2.4.5. поиск последних успешных запусков сборки по идентификатору группы отображения и номеру списка изменений

2.4.6. Получение Атрибутов Запуска Сборки

2.4.7. получение списков изменений в заданном ходе сборки

2.4.8. Получение Изменений Списка Изменений

2.4.9. Получение Выполнения Шага Сборки

2.4.10. Получение Атрибутов Выполнения Шага

2.4.11. Получение Журналов Этапов Сборки

2.4.12. Получение Результатов Этапа Сборки

2.4.13. Получение Списка Изменений

2.4.14. Получение Примечаний К Выпуску

2.4.15. Получение Выпуска

2.4.16. Получение Атрибутов Выпуска

2.4.17. Получение Списков Изменений Выпуска

2.4.18. Запрос Групп Результатов

2.4.19. Запрос Групп Результатов Проекта

2.4.20. Получение Результирующих Конфигураций

2.4.21. Получение Свойств Конфигурации Результата

2.4.22. Получение Опубликованных Результатов Этапа Сборки

2.4.23. Получение Действий По Запуску Сборки

2.4.24. Запрос Имен Наборов Тестов

2.4.25. Получение имен тестовых наборов

2.4.26. Получение Тестов Build Run

2.5. Запрос Статистики Сборки

2.5.1. Запрос Почасовой Статистики Сборки

2.5.2. Запрос Ежедневной Статистики Сборки

2.5.3. Запрос Ежемесячной Статистики Сборки

2.5.4. Запрос Годовой Статистики Сборки

2.5.5. Запрос Почасового Распределения Сборки

2.5.6. Запрос Дистрибутива Сборки По Будням

2.5.7. Запрос Ежечасной Статистики Тестов

2.5.8. Запрос Ежедневной Статистики Тестов

2.5.9. Запрос Ежемесячной Статистики Тестов

2.6. Управление Сборками

2.6.1. Начало Сборки

2.6.2. Остановка Сборки

2.6.3. Возобновление Сборки

2.6.4. Запрос Чистой Проверки

2.6.5. Перечисление Текущих Статусов Сборки

2.6.6. Поиск текущего состояния сборки по идентификатору сборки

2.6.7. Поиск текущего состояния сборки по имени сборки

2.6.8. Поиск текущих статусов сборки по регулярному выражению

2.6.9. Изменение Настроек Контроля Версий

2.6.10. Изменение Последовательности Сборки

2.6.11. Изменение Настроек Расписания

Список таблиц

2.1.

2.2.

Предисловие

Содержание

1. Об Этом Руководстве

2. аудитория

3. Техническая Поддержка

Об Этом Руководстве

Данное руководство содержит описание API веб-службы Parabuild.

Аудитория

Это руководство предназначено для инженеров-программистов.

Техническая Поддержка

Если у вас возникли какие-либо проблемы с программным обеспечением или документацией, пожалуйста, свяжитесь со службой технической поддержки через онлайн-форумы поддержки, электронную почту, факс или как описано ниже. Для получения дополнительной информации о другой поддержке перейдите по ссылке поддержка на веб -сайте по адресуwww.parabuildci.org.

Форум Поддержки:

http://forums.parabuildci.org/viewforum.php?f=1

Электронная Почта:

[e-mail]

Факс:

650-240-4455