Approvals - Query
Вывод списка утверждений. Это можно использовать для получения набора ожидающих утверждений в конвейере, пользователя или ресурса.
GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?api-version=7.1
GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?approvalIds={approvalIds}&$expand={$expand}&userIds={userIds}&state={state}&top={top}&api-version=7.1
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
organization
|
path | True |
string |
Имя организации Azure DevOps. |
project
|
path | True |
string |
Идентификатор проекта или имя проекта |
api-version
|
query | True |
string |
Используемая версия API. Для использования этой версии API необходимо задать значение "7.1". |
$expand
|
query |
Включите эти дополнительные сведения в возвращаемые объекты. |
||
approval
|
query |
string (array (uuid)) |
Список идентификаторов утверждения для получения. |
|
state
|
query |
Состояние утверждения. Возвращает утверждения любого состояния, если оно не указано |
||
top
|
query |
integer (int32) |
Максимальное количество утверждений для получения. |
|
user
|
query |
string (array (string)) |
Список утверждений идентификаторов пользователей, назначенных. Принимает идентификаторы пользователей или дескрипторы пользователей. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Approval[] |
успешная операция |
Безопасность
oauth2
Тип:
oauth2
Flow:
accessCode
URL-адрес авторизации:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL-адрес токена:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Области
Имя | Описание |
---|---|
vso.build | Предоставляет возможность доступа к артефактам сборки, включая результаты сборки, определения и запросы, а также возможность получать уведомления о событиях сборки с помощью перехватчиков служб. |
Примеры
Образец запроса
GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?approvalIds=ee14f612-6838-43c0-b445-db238ef14153,06239b11-a904-43a1-be6a-0d44026bd121&api-version=7.1
Пример ответа
request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context
{
"count": 2,
"value": [
{
"id": "ee14f612-6838-43c0-b445-db238ef14153",
"steps": [],
"status": "pending",
"createdOn": "2020-11-19T08:14:49.58Z",
"lastModifiedOn": "2020-11-19T08:14:49.5793622Z",
"executionOrder": "anyOrder",
"minRequiredApprovers": 1,
"blockedApprovers": [],
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/approvals/ee14f612-6838-43c0-b445-db238ef14153"
}
}
},
{
"id": "06239b11-a904-43a1-be6a-0d44026bd121",
"steps": [],
"status": "pending",
"createdOn": "2020-11-19T09:39:35.28Z",
"lastModifiedOn": "2020-11-19T09:39:35.2806001Z",
"executionOrder": "anyOrder",
"minRequiredApprovers": 1,
"blockedApprovers": [],
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/approvals/06239b11-a904-43a1-be6a-0d44026bd121"
}
}
}
]
}
Определения
Имя | Описание |
---|---|
Approval | |
Approval |
Включите эти дополнительные сведения в возвращаемые объекты. |
Approval |
Порядок, в котором утверждающие будут действовать. |
Approval |
Текущие разрешения пользователя для объекта утверждения. |
Approval |
Общее состояние утверждения. |
Approval |
Данные для одного шага утверждения. |
Approval |
Данные для одного журнала шагов утверждения. |
Identity |
|
Reference |
Класс, представляющий коллекцию ссылок REST. |
Approval
Имя | Тип | Описание |
---|---|---|
_links |
Получает ссылки для доступа к объекту утверждения. |
|
blockedApprovers |
Удостоверения, которые не допускаются для утверждения. |
|
createdOn |
string (date-time) |
Дата создания утверждения. |
executionOrder |
Порядок, в котором утверждающие будут действовать. |
|
id |
string (uuid) |
Уникальный идентификатор утверждения. |
instructions |
string |
Инструкции для утверждающих. |
lastModifiedOn |
string (date-time) |
Дата последнего изменения утверждения. |
minRequiredApprovers |
integer (int32) |
Минимальное число утверждающих, которые должны утверждаться для всего утверждения, которое будет считаться утвержденным. |
permissions |
Текущие разрешения пользователя для объекта утверждения. |
|
status |
Общее состояние утверждения. |
|
steps |
Список шагов, связанных с утверждением. |
ApprovalDetailsExpandParameter
Включите эти дополнительные сведения в возвращаемые объекты.
Значение | Описание |
---|---|
none |
Никаких дополнительных свойств. |
permissions |
Включите текущие разрешения пользователя для объекта утверждения. |
steps |
Включите шаги утверждения, связанные с утверждением. |
ApprovalExecutionOrder
Порядок, в котором утверждающие будут действовать.
Значение | Описание |
---|---|
anyOrder |
Указывает, что утверждающие могут утверждаться в любом порядке. |
inSequence |
Указывает, что утверждающие могут утверждать только в последовательном порядке (порядок, в котором они были назначены). |
ApprovalPermissions
Текущие разрешения пользователя для объекта утверждения.
Значение | Описание |
---|---|
none | |
queueBuild | |
reassign | |
resourceAdmin | |
update | |
view |
ApprovalStatus
Общее состояние утверждения.
Значение | Описание |
---|---|
all | |
approved |
Указывает, что утверждение утверждено. |
canceled |
Указывает, что утверждение отменено. |
completed | |
failed | |
pending |
Указывает, что утверждение ожидается. |
rejected |
Указывает, что утверждение отклонено. |
skipped |
Указывает, что утверждение пропущено. |
timedOut |
Указывает время ожидания утверждения. |
undefined | |
uninitiated |
Указывает, что утверждение не указано. Используется в случае последовательности выполнения, где данный утверждающий пока не подходит для действий. |
ApprovalStep
Данные для одного шага утверждения.
Имя | Тип | Описание |
---|---|---|
actualApprover |
Удостоверение, утвержденное. |
|
assignedApprover |
Удостоверение, которому следует утвердить. |
|
comment |
string |
Комментарий, связанный с этим шагом. |
history |
История шага утверждения |
|
initiatedOn |
string (date-time) |
Метка времени, с которой был инициирован этот шаг. |
lastModifiedBy |
Удостоверение, с помощью которого последний шаг был изменен. |
|
lastModifiedOn |
string (date-time) |
Метка времени последнего изменения этого шага. |
order |
integer (int32) |
Порядок утверждения утверждающих. |
permissions |
Текущие разрешения пользователя для шага. |
|
status |
Текущее состояние этого шага. |
ApprovalStepHistory
Данные для одного журнала шагов утверждения.
Имя | Тип | Описание |
---|---|---|
assignedTo |
Удостоверение, которому было назначено это утверждение |
|
comment |
string |
Комментарий, связанный с этим журналом шагов. |
createdBy |
Удостоверение, с помощью которого был создан журнал шагов. |
|
createdOn |
string (date-time) |
Метка времени создания журнала шагов. |
IdentityRef
Имя | Тип | Описание |
---|---|---|
_links |
Это поле содержит нулевые или более интересные ссылки на тему графа. Эти ссылки могут вызываться для получения дополнительных связей или более подробных сведений об этой теме графа. |
|
descriptor |
string |
Дескриптор является основным способом ссылки на тему графа во время выполнения системы. Это поле однозначно определяет одну и ту же тему графа как в учетных записях, так и в организациях. |
directoryAlias |
string |
Нерекомендуемое. Можно получить, запросив пользователя Graph, на который ссылается пользователь Graph в записи "self" словаря IdentityRef "_links" |
displayName |
string |
Это не уникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в исходном поставщике. |
id |
string |
|
imageUrl |
string |
Не рекомендуется . Доступно в записи "аватар" словаря IdentityRef "_links" |
inactive |
boolean |
Нерекомендуемый — можно получить, запросив состояние членства Graph, на которое ссылается запись "membershipState" словаря GraphUser "_links" |
isAadIdentity |
boolean |
Нерекомендуемый — можно выводить из типа субъекта дескриптора (descriptor.IsAadUserType/descriptor.IsAadGroupType) |
isContainer |
boolean |
Нерекомендуемый — можно выводить из типа субъекта дескриптора (descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
Не рекомендуется — не используется в большинстве стандартных реализаций ToIdentityRef |
uniqueName |
string |
Не рекомендуется — вместо этого используйте domain+PrincipalName |
url |
string |
Этот URL-адрес является полным маршрутом к исходному ресурсу данного субъекта графа. |
ReferenceLinks
Класс, представляющий коллекцию ссылок REST.
Имя | Тип | Описание |
---|---|---|
links |
object |
Режим чтения ссылок. Так как ссылки ссылки доступны только для чтения, мы хотим предоставлять их только как доступные только для чтения. |