Approvals - Query

Ссылка

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Список утверждений. Его можно использовать для получения набора ожидающих утверждений в конвейере, для пользователя или для ресурса.

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?api-version=7.1-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?approvalIds={approvalIds}&$expand={$expand}&userIds={userIds}&state={state}&top={top}&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.
$expand	query		ApprovalDetailsExpandParameter	Включите эти дополнительные сведения в возвращаемые объекты.
approvalIds	query		string array (uuid)	Список идентификаторов утверждений, которые необходимо получить.
state	query		ApprovalStatus	Состояние утверждения. Возвращает утверждения любого состояния, если они не указаны
top	query		integer int32	Максимальное число утверждений для получения.
userIds	query		string array (string)	Список назначенных утверждений идентификаторов пользователей. Принимает идентификаторы пользователей или дескрипторы пользователей.

Ответы

Имя	Тип	Описание
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	Предоставляет возможность доступа к артефактам сборки, включая результаты сборки, определения и запросы, а также возможность получать уведомления о событиях сборки с помощью перехватчиков служб.

Примеры

Sample Request

HTTP

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-preview.1

Sample Response

Status code:: 200

request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context

Response Body

{
  "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
ApprovalDetailsExpandParameter	Включите эти дополнительные сведения в возвращаемые объекты.
ApprovalExecutionOrder	Порядок, в котором утверждающие будут принимать меры.
ApprovalPermissions	Разрешения текущего пользователя для объекта утверждения.
ApprovalStatus	Общее состояние утверждения.
ApprovalStep	Данные для одного шага утверждения.
ApprovalStepHistory	Данные для одного этапа утверждения.
IdentityRef
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.

Approval

Имя	Тип	Описание
_links	ReferenceLinks	Возвращает ссылки для доступа к объекту утверждения.
blockedApprovers	IdentityRef[]	Удостоверения, которые не разрешено утверждать.
createdOn	string	Дата создания утверждения.
executionOrder	ApprovalExecutionOrder	Порядок, в котором утверждающие будут принимать меры.
id	string	Уникальный идентификатор утверждения.
instructions	string	Инструкции для утверждающих.
lastModifiedOn	string	Дата последнего изменения утверждения.
minRequiredApprovers	integer	Минимальное число утверждающих, которые должны утвердить все утверждения, которые будут считаться утвержденными.
permissions	ApprovalPermissions	Разрешения текущего пользователя для объекта утверждения.
status	ApprovalStatus	Общее состояние утверждения.
steps	ApprovalStep[]	Список шагов, связанных с утверждением.

ApprovalDetailsExpandParameter

Включите эти дополнительные сведения в возвращаемые объекты.

Имя	Тип	Описание
none	string	Нет дополнительных свойств.
permissions	string	Включите разрешения текущего пользователя для объекта утверждения.
steps	string	Включите шаги утверждения, связанные с утверждением.

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	IdentityRef	Удостоверение, утвердившего утверждение.
assignedApprover	IdentityRef	Удостоверяет, кто должен утвердить.
comment	string	Комментарий, связанный с этим шагом.
history	ApprovalStepHistory[]	Журнал этапа утверждения
initiatedOn	string	Метка времени, с которой был инициирован этот шаг.
lastModifiedBy	IdentityRef	Удостоверение, с помощью которого этот шаг был изменен в последний раз.
lastModifiedOn	string	Метка времени последнего изменения этого шага.
order	integer	Порядок, в котором утверждающие могут утверждать.
permissions	ApprovalPermissions	Текущие разрешения пользователя для шага.
status	ApprovalStatus	Текущее состояние этого шага.

ApprovalStepHistory

Данные для одного этапа утверждения.

Имя	Тип	Описание
assignedTo	IdentityRef	Удостоверение, которому было назначено это утверждение
comment	string	Комментарий, связанный с этим журналом шагов.
createdBy	IdentityRef	Удостоверение, с помощью которого был создан этот журнал шагов.
createdOn	string	Метка времени создания журнала этого шага.

IdentityRef

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа.
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	Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.