Approvals - Update

Referência

Serviço:: Approvals And Checks

Versão da API:: 7.1

Atualizar aprovações.

PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?api-version=7.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' para usar essa versão da api.

Corpo da solicitação

Nome	Tipo	Description
body	ApprovalUpdateParameters[]

Respostas

Nome	Tipo	Description
200 OK	Approval[]	operação bem-sucedida

Segurança

oauth2

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token: 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

Escopos

Nome	Description
vso.build_execute	Concede a capacidade de acessar artefatos de build, incluindo resultados de build, definições e solicitações, e a capacidade de enfileirar um build, atualizar propriedades de build e a capacidade de receber notificações sobre eventos de build por meio de ganchos de serviço.
vso.pipelineresources_use	Concede a capacidade de aprovar a solicitação de um pipeline para usar um recurso protegido: pool de agentes, ambiente, fila, repositório, arquivos seguros, conexão de serviço e grupo de variáveis

Exemplos

Solicitação de exemplo

HTTP

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

[
  {
    "approvalId": "aab27959-a5be-4ee3-97ca-f19b3602cd2f",
    "comment": "Approving",
    "status": "approved"
  }
]

Resposta de exemplo

Código de status:: 200

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

Definições

Nome	Description
Approval
ApprovalExecutionOrder	Ordem na qual os aprovadores serão acionáveis.
ApprovalPermissions	Permissões de usuário atuais para objeto de aprovação.
ApprovalStatus	Status geral da aprovação.
ApprovalStep	Dados para uma única etapa de aprovação.
ApprovalStepHistory	Dados para um único histórico de etapas de aprovação.
ApprovalUpdateParameters	Dados para atualizar um objeto de aprovação ou sua etapa individual.
IdentityRef
ReferenceLinks	A classe para representar uma coleção de links de referência REST.

Approval

Objeto

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 (date-time)	Data em que a aprovação foi criada.
executionOrder	ApprovalExecutionOrder	Ordem na qual os aprovadores serão acionáveis.
id	string (uuid)	Identificador exclusivo da aprovação.
instructions	string	Instruções para os aprovadores.
lastModifiedOn	string (date-time)	Data em que a aprovação foi modificada pela última vez.
minRequiredApprovers	integer (int32)	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 objeto de aprovação.
status	ApprovalStatus	Status geral da aprovação.
steps	ApprovalStep[]	Lista de etapas associadas à aprovação.

ApprovalExecutionOrder

Enumeração

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

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

ApprovalPermissions

Enumeração

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

Valor	Description
none
queueBuild
reassign
resourceAdmin
update
view

ApprovalStatus

Enumeração

Status geral da aprovação.

Valor	Description
all
approved	Indica que a aprovação foi aprovada.
canceled	Indica que a aprovação foi cancelada.
completed
failed
pending	Indica que a aprovação está pendente.
rejected	Indica que a aprovação foi rejeitada.
skipped	Indica que a aprovação foi ignorada.
timedOut	Indica que a aprovação está em tempo limite.
undefined
uninitiated	Indica que a aprovação não foi inicializada. Usado em caso de ordem de execução em sequência em que o aprovador especificado ainda não é acionável.

ApprovalStep

Objeto

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 (date-time)	Carimbo de data/hora em que esta etapa foi iniciada.
lastModifiedBy	IdentityRef	Identidade pela qual esta etapa foi modificada pela última vez.
lastModifiedOn	string (date-time)	Carimbo de data/hora em que esta etapa foi modificada pela última vez.
order	integer (int32)	Ordem na qual os aprovadores têm permissão para aprovar.
permissions	ApprovalPermissions	Permissões de usuário atuais para a etapa.
status	ApprovalStatus	Status atual desta etapa.

ApprovalStepHistory

Objeto

Dados para 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 (date-time)	Carimbo de data/hora em que esse histórico de etapas foi criado.

ApprovalUpdateParameters

Objeto

Dados para atualizar um objeto de aprovação ou sua etapa individual.

Nome	Tipo	Description
approvalId	string (uuid)	ID da aprovação a ser atualizada.
assignedApprover	IdentityRef	Aprovador atual.
comment	string	Obtém ou define o comentário.
reassignTo	IdentityRef	Aprovador reatribuído.
status	ApprovalStatus	Obtém ou define o status.

IdentityRef

Objeto

Nome	Tipo	Description
_links	ReferenceLinks	Este 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 em contas e organizações.
directoryAlias	string	Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário "_links" identityRef
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 "_links" do IdentityRef
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 adiado 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 pré-existentes 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.

ReferenceLinks

Objeto

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.

Partilhar via

Approvals - Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

oauth2

Escopos

Exemplos

Solicitação de exemplo

Resposta de exemplo

Definições

Approval

ApprovalExecutionOrder

ApprovalPermissions

ApprovalStatus

ApprovalStep

ApprovalStepHistory

ApprovalUpdateParameters

IdentityRef

ReferenceLinks