Approvals - Update
Обновление утверждений.
PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?api-version=7.1-preview.1
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
organization
|
path | True |
string |
Название организации Azure DevOps. |
project
|
path | True |
string |
Идентификатор проекта или имя проекта |
api-version
|
query | True |
string |
Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1. |
Текст запроса
Имя | Тип | Описание |
---|---|---|
body |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Approval[] |
успешная операция |
Безопасность
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token 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
Scopes
Имя | Описание |
---|---|
vso.build_execute | Предоставляет возможность доступа к артефактам сборки, включая результаты сборки, определения и запросы, а также возможность ставить сборку в очередь, обновлять свойства сборки и получать уведомления о событиях сборки с помощью перехватчиков служб. |
vso.pipelineresources_use | Предоставляет возможность утверждать запрос конвейера на использование защищенного ресурса: пул агентов, среда, очередь, репозиторий, защищенные файлы, подключение службы и группа переменных. |
Примеры
Sample Request
PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?api-version=7.1-preview.1
[
{
"approvalId": "aab27959-a5be-4ee3-97ca-f19b3602cd2f",
"comment": "Approving",
"status": "approved"
}
]
Sample Response
request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context
{
"count": 1,
"value": [
{
"id": "aab27959-a5be-4ee3-97ca-f19b3602cd2f",
"steps": [
{
"assignedApprover": {
"displayName": "User Name",
"id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
"uniqueName": "uniqueName",
"descriptor": "Descriptor"
},
"actualApprover": {
"displayName": "User Name",
"id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
"uniqueName": "uniqueName",
"descriptor": "Descriptor"
},
"status": "approved",
"comment": "Approving",
"lastModifiedOn": "2020-11-19T09:57:54.252505Z",
"order": 1,
"lastModifiedBy": {
"displayName": "User Name",
"id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
"uniqueName": "uniqueName",
"descriptor": "Descriptor"
},
"initiatedOn": "2020-11-19T09:51:16.7045043Z",
"history": []
}
],
"status": "approved",
"createdOn": "2020-11-19T09:51:16.703Z",
"lastModifiedOn": "2020-11-19T09:57:54.252505Z",
"executionOrder": "anyOrder",
"minRequiredApprovers": 1,
"blockedApprovers": [],
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/approvals/aab27959-a5be-4ee3-97ca-f19b3602cd2f"
}
}
}
]
}
Определения
Имя | Описание |
---|---|
Approval | |
Approval |
Порядок, в котором утверждающие будут принимать меры. |
Approval |
Разрешения текущего пользователя для объекта утверждения. |
Approval |
Общее состояние утверждения. |
Approval |
Данные для одного шага утверждения. |
Approval |
Данные для одного этапа утверждения. |
Approval |
Данные для обновления объекта утверждения или его отдельного шага. |
Identity |
|
Reference |
Класс, представляющий коллекцию ссылок REST. |
Approval
Имя | Тип | Описание |
---|---|---|
_links |
Возвращает ссылки для доступа к объекту утверждения. |
|
blockedApprovers |
Удостоверения, которые не разрешено утверждать. |
|
createdOn |
string |
Дата создания утверждения. |
executionOrder |
Порядок, в котором утверждающие будут принимать меры. |
|
id |
string |
Уникальный идентификатор утверждения. |
instructions |
string |
Инструкции для утверждающих. |
lastModifiedOn |
string |
Дата последнего изменения утверждения. |
minRequiredApprovers |
integer |
Минимальное число утверждающих, которые должны утвердить все утверждения, которые будут считаться утвержденными. |
permissions |
Разрешения текущего пользователя для объекта утверждения. |
|
status |
Общее состояние утверждения. |
|
steps |
Список шагов, связанных с утверждением. |
ApprovalExecutionOrder
Порядок, в котором утверждающие будут принимать меры.
Имя | Тип | Описание |
---|---|---|
anyOrder |
string |
Указывает, что утверждающие могут утверждать в любом порядке. |
inSequence |
string |
Указывает, что утверждающие могут утверждать только в последовательном порядке (порядок, в котором они были назначены). |
ApprovalPermissions
Разрешения текущего пользователя для объекта утверждения.
Имя | Тип | Описание |
---|---|---|
none |
string |
|
queueBuild |
string |
|
reassign |
string |
|
resourceAdmin |
string |
|
update |
string |
|
view |
string |
ApprovalStatus
Общее состояние утверждения.
Имя | Тип | Описание |
---|---|---|
all |
string |
|
approved |
string |
Указывает, что утверждение утверждено. |
canceled |
string |
Указывает, что утверждение отменено. |
completed |
string |
|
failed |
string |
|
pending |
string |
Указывает, что утверждение находится в ожидании. |
rejected |
string |
Указывает, что утверждение отклонено. |
skipped |
string |
Указывает, что утверждение пропущено. |
timedOut |
string |
Указывает, что время ожидания утверждения истекло. |
undefined |
string |
|
uninitiated |
string |
Указывает, что утверждение имеет значение Uninitiated. Используется в случае в последовательности выполнения, где данный утверждающий еще не может быть применен. |
ApprovalStep
Данные для одного шага утверждения.
Имя | Тип | Описание |
---|---|---|
actualApprover |
Удостоверение, утвердившего утверждение. |
|
assignedApprover |
Удостоверяет, кто должен утвердить. |
|
comment |
string |
Комментарий, связанный с этим шагом. |
history |
Журнал этапа утверждения |
|
initiatedOn |
string |
Метка времени, с которой был инициирован этот шаг. |
lastModifiedBy |
Удостоверение, с помощью которого этот шаг был изменен в последний раз. |
|
lastModifiedOn |
string |
Метка времени последнего изменения этого шага. |
order |
integer |
Порядок, в котором утверждающие могут утверждать. |
permissions |
Текущие разрешения пользователя для шага. |
|
status |
Текущее состояние этого шага. |
ApprovalStepHistory
Данные для одного этапа утверждения.
Имя | Тип | Описание |
---|---|---|
assignedTo |
Удостоверение, которому было назначено это утверждение |
|
comment |
string |
Комментарий, связанный с этим журналом шагов. |
createdBy |
Удостоверение, с помощью которого был создан этот журнал шагов. |
|
createdOn |
string |
Метка времени создания журнала этого шага. |
ApprovalUpdateParameters
Данные для обновления объекта утверждения или его отдельного шага.
Имя | Тип | Описание |
---|---|---|
approvalId |
string |
Идентификатор утверждения для обновления. |
assignedApprover |
Текущий утверждающий. |
|
comment |
string |
Возвращает или задает комментарий. |
reassignTo |
Переназначение утверждающего. |
|
status |
Возвращает или задает состояние. |
IdentityRef
Имя | Тип | Описание |
---|---|---|
_links |
Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа. |
|
descriptor |
string |
Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях. |
directoryAlias |
string |
Нерекомендуемый — можно получить, запросив пользователя 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 |
Нерекомендуемый — используйте вместо этого домен+имя_субъекта |
url |
string |
Этот URL-адрес является полным маршрутом к исходному ресурсу этого субъекта графа. |
ReferenceLinks
Класс, представляющий коллекцию ссылок REST.
Имя | Тип | Описание |
---|---|---|
links |
object |
Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения. |