Compartilhar via


Approvals - Query

Listar Aprovações. Isso pode ser usado para obter um conjunto de aprovações pendentes em um pipeline, em um usuário ou para um recurso..

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?api-version=7.1-preview.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-preview.1

Parâmetros de URI

Nome Em Obrigatório Tipo Description
organization
path True

string

O nome da organização do Azure DevOps.

project
path True

string

ID do projeto ou nome do projeto

api-version
query True

string

Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar essa versão da api.

$expand
query

ApprovalDetailsExpandParameter

Inclua esses detalhes adicionais nos objetos retornados.

approvalIds
query

string

array (uuid)

Lista de IDs de aprovação a serem obtidos.

state
query

ApprovalStatus

Status de aprovação. Retorna aprovações de qualquer status se não for fornecido

top
query

integer

int32

Número máximo de aprovações a serem obtidos.

userIds
query

string

array (string)

Lista de aprovações de IDs de usuário atribuídas a. Aceita IDs de usuário ou descritores de usuário.

Respostas

Nome Tipo Description
200 OK

Approval[]

operação bem-sucedida

Segurança

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

Nome Description
vso.build Concede a capacidade de acessar artefatos de build, incluindo resultados de build, definições e solicitações e a capacidade de receber notificações sobre eventos de build por meio de ganchos de serviço.

Exemplos

Sample Request

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

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"
        }
      }
    }
  ]
}

Definições

Nome Description
Approval
ApprovalDetailsExpandParameter

Inclua esses detalhes adicionais nos objetos retornados.

ApprovalExecutionOrder

Ordem na qual os aprovadores serão acionáveis.

ApprovalPermissions

Permissões de usuário atuais para o objeto de aprovação.

ApprovalStatus

Status geral da aprovação.

ApprovalStep

Dados para uma única etapa de aprovação.

ApprovalStepHistory

Dados de um único histórico de etapas de aprovação.

IdentityRef
ReferenceLinks

A classe para representar uma coleção de links de referência REST.

Approval

Nome Tipo Description
_links

ReferenceLinks

Obtém os links para acessar o objeto de aprovação.

blockedApprovers

IdentityRef[]

Identidades que não têm permissão para aprovar.

createdOn

string

Data em que a aprovação foi criada.

executionOrder

ApprovalExecutionOrder

Ordem na qual os aprovadores serão acionáveis.

id

string

Identificador exclusivo da aprovação.

instructions

string

Instruções para os aprovadores.

lastModifiedOn

string

Data em que a aprovação foi modificada pela última vez.

minRequiredApprovers

integer

Número mínimo de aprovadores que devem aprovar para que toda a aprovação seja considerada aprovada.

permissions

ApprovalPermissions

Permissões de usuário atuais para o objeto de aprovação.

status

ApprovalStatus

Status geral da aprovação.

steps

ApprovalStep[]

Lista de etapas associadas à aprovação.

ApprovalDetailsExpandParameter

Inclua esses detalhes adicionais nos objetos retornados.

Nome Tipo Description
none

string

Nenhuma propriedade adicional.

permissions

string

Inclua as permissões de usuário atuais para o objeto de aprovação.

steps

string

Inclua as etapas de aprovação associadas à aprovação.

ApprovalExecutionOrder

Ordem na qual os aprovadores serão acionáveis.

Nome Tipo Description
anyOrder

string

Indica que os aprovadores podem aprovar em qualquer ordem.

inSequence

string

Indica que os aprovadores só podem aprovar em uma ordem sequencial (Ordem na qual foram atribuídos).

ApprovalPermissions

Permissões de usuário atuais para o objeto de aprovação.

Nome Tipo Description
none

string

queueBuild

string

reassign

string

resourceAdmin

string

update

string

view

string

ApprovalStatus

Status geral da aprovação.

Nome Tipo Description
all

string

approved

string

Indica que a aprovação é Aprovada.

canceled

string

Indica que a aprovação foi Cancelada.

completed

string

failed

string

pending

string

Indica que a aprovação está pendente.

rejected

string

Indica que a aprovação foi rejeitada.

skipped

string

Indica que a aprovação foi ignorada.

timedOut

string

Indica que a aprovação está em tempo limite.

undefined

string

uninitiated

string

Indica que a aprovação não foi iniciada. Usado no caso de em ordem de execução em que determinado aprovador ainda não é acionável.

ApprovalStep

Dados para uma única etapa de aprovação.

Nome Tipo Description
actualApprover

IdentityRef

Identidade que aprovou.

assignedApprover

IdentityRef

Identidade que deve aprovar.

comment

string

Comentário associado a esta etapa.

history

ApprovalStepHistory[]

Histórico da etapa de aprovação

initiatedOn

string

Carimbo de data/hora em que esta etapa foi iniciada.

lastModifiedBy

IdentityRef

Identidade pela qual esta etapa foi modificada pela última vez.

lastModifiedOn

string

Carimbo de data/hora em que esta etapa foi modificada pela última vez.

order

integer

Ordem na qual os aprovadores têm permissão para aprovar.

permissions

ApprovalPermissions

Permissões de usuário atuais para a etapa.

status

ApprovalStatus

O status atual desta etapa.

ApprovalStepHistory

Dados de um único histórico de etapas de aprovação.

Nome Tipo Description
assignedTo

IdentityRef

Identidade que recebeu essa aprovação

comment

string

Comentário associado a este histórico de etapas.

createdBy

IdentityRef

Identidade pela qual esse histórico de etapas foi criado.

createdOn

string

Carimbo de data/hora em que esse histórico de etapas foi criado.

IdentityRef

Nome Tipo Description
_links

ReferenceLinks

Esse campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo.

descriptor

string

O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto de grafo entre contas e organizações.

directoryAlias

string

Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário IdentityRef "_links"

displayName

string

Esse é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem.

id

string

imageUrl

string

Preterido – Disponível na entrada "avatar" do dicionário IdentityRef "_links"

inactive

boolean

Preterido – pode ser recuperado consultando o estado de associação do Graph referenciado na entrada "membershipState" do dicionário "_links" do GraphUser

isAadIdentity

boolean

Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)

isContainer

boolean

Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsGroupType)

isDeletedInOrigin

boolean

profileUrl

string

Preterido – não em uso na maioria das implementações preexistir de ToIdentityRef

uniqueName

string

Preterido – use Domain+PrincipalName em vez disso

url

string

Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

A classe para representar uma coleção de links de referência REST.

Nome Tipo Description
links

object

A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.