Approvals - Get

Odwołanie

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Uzyskaj zatwierdzenie.

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

With optional parameters:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
approvalId	path	True	string uuid	Identyfikator zatwierdzenia.
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path	True	string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Ta wartość powinna być ustawiona na wartość "7.1-preview.1", aby używać tej wersji interfejsu API.
$expand	query		ApprovalDetailsExpandParameter

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Approval	operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa	Opis
vso.build	Umożliwia dostęp do artefaktów kompilacji, w tym wyników kompilacji, definicji i żądań oraz możliwość odbierania powiadomień o zdarzeniach kompilacji za pośrednictwem punktów zaczepienia usługi.

Przykłady

Sample Request

HTTP

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals/{approvalId}?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

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

Definicje

Nazwa	Opis
Approval
ApprovalDetailsExpandParameter
ApprovalExecutionOrder	Kolejność, w której osoby zatwierdzające będą możliwe do działania.
ApprovalPermissions	Bieżące uprawnienia użytkownika do obiektu zatwierdzania.
ApprovalStatus	Ogólny stan zatwierdzenia.
ApprovalStep	Dane dla pojedynczego kroku zatwierdzania.
ApprovalStepHistory	Dane dla historii pojedynczego kroku zatwierdzania.
IdentityRef
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.

Approval

Nazwa	Typ	Opis
_links	ReferenceLinks	Pobiera łącza w celu uzyskania dostępu do obiektu zatwierdzania.
blockedApprovers	IdentityRef[]	Tożsamości, które nie mogą być zatwierdzane.
createdOn	string	Data utworzenia zatwierdzenia.
executionOrder	ApprovalExecutionOrder	Kolejność, w której osoby zatwierdzające będą możliwe do działania.
id	string	Unikatowy identyfikator zatwierdzenia.
instructions	string	Instrukcje dla osób zatwierdzających.
lastModifiedOn	string	Data ostatniej modyfikacji zatwierdzenia.
minRequiredApprovers	integer	Minimalna liczba osób zatwierdzających, które powinny zatwierdzić całe zatwierdzenie do zatwierdzenia.
permissions	ApprovalPermissions	Bieżące uprawnienia użytkownika do obiektu zatwierdzania.
status	ApprovalStatus	Ogólny stan zatwierdzenia.
steps	ApprovalStep[]	Lista kroków skojarzonych z zatwierdzeniem.

ApprovalDetailsExpandParameter

Nazwa	Typ	Opis
none	string	Brak dodatkowych właściwości.
permissions	string	Uwzględnij bieżące uprawnienia użytkownika do obiektu zatwierdzania.
steps	string	Uwzględnij kroki zatwierdzania skojarzone z zatwierdzeniem.

ApprovalExecutionOrder

Kolejność, w której osoby zatwierdzające będą możliwe do działania.

Nazwa	Typ	Opis
anyOrder	string	Wskazuje, że osoby zatwierdzające mogą zatwierdzić w dowolnej kolejności.
inSequence	string	Wskazuje, że osoby zatwierdzające mogą zatwierdzać tylko w kolejności sekwencyjnej (kolejność, w której zostały przypisane).

ApprovalPermissions

Bieżące uprawnienia użytkownika do obiektu zatwierdzania.

Nazwa	Typ	Opis
none	string
queueBuild	string
reassign	string
resourceAdmin	string
update	string
view	string

ApprovalStatus

Ogólny stan zatwierdzenia.

Nazwa	Typ	Opis
all	string
approved	string	Wskazuje zatwierdzenie jest zatwierdzone.
canceled	string	Wskazuje, że zatwierdzenie zostało anulowane.
completed	string
failed	string
pending	string	Wskazuje, że zatwierdzenie jest oczekujące.
rejected	string	Wskazuje, że zatwierdzenie zostało odrzucone.
skipped	string	Wskazuje, że zatwierdzenie zostało pominięte.
timedOut	string	Wskazuje, że zatwierdzenie jest przekroczone limit czasu.
undefined	string
uninitiated	string	Wskazuje, że zatwierdzenie jest nie zainicjowane. Używany w przypadku sekwencji wykonywania, w której dana osoba zatwierdzająca nie jest jeszcze dostępna do wykonania.

ApprovalStep

Dane dla pojedynczego kroku zatwierdzania.

Nazwa	Typ	Opis
actualApprover	IdentityRef	Tożsamość, która zatwierdziła.
assignedApprover	IdentityRef	Tożsamość, która powinna zostać zatwierdź.
comment	string	Komentarz skojarzony z tym krokiem.
history	ApprovalStepHistory[]	Historia kroku zatwierdzania
initiatedOn	string	Sygnatura czasowa, w której zainicjowano ten krok.
lastModifiedBy	IdentityRef	Tożsamość, za pomocą której ten krok został ostatnio zmodyfikowany.
lastModifiedOn	string	Sygnatura czasowa ostatniej modyfikacji tego kroku.
order	integer	Kolejność zatwierdzania przez osoby zatwierdzające.
permissions	ApprovalPermissions	Bieżące uprawnienia użytkownika dla kroku.
status	ApprovalStatus	Bieżący stan tego kroku.

ApprovalStepHistory

Dane dla historii pojedynczego kroku zatwierdzania.

Nazwa	Typ	Opis
assignedTo	IdentityRef	Tożsamość, która została przypisana do tego zatwierdzenia
comment	string	Komentarz skojarzony z tą historią kroków.
createdBy	IdentityRef	Tożsamość, za pomocą której utworzono tę historię kroków.
createdOn	string	Sygnatura czasowa, w której utworzono tę historię kroków.

IdentityRef

Nazwa	Typ	Opis
_links	ReferenceLinks	To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu.
descriptor	string	Deskryptor jest podstawowym sposobem odwoływanie się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji.
directoryAlias	string	Przestarzałe — można je pobrać, wykonując zapytanie względem użytkownika programu Graph, do których odwołuje się wpis "self" słownika IdentityRef "_links"
displayName	string	Jest to nieu unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, należy zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string	Przestarzałe — dostępne we wpisie "avatar" słownika IdentityRef "_links"
inactive	boolean	Przestarzałe — można pobrać, wykonując zapytanie dotyczące stanu członkostwa programu Graph, do których odwołuje się wpis "membershipState" słownika GraphUser "_links"
isAadIdentity	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Przestarzałe — nie jest używane w większości istniejących implementacji elementu ToIdentityRef
uniqueName	string	Przestarzałe — zamiast tego użyj nazwy Domain+PrincipalName
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Widok linków w trybie tylko do odczytu. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.

Udostępnij za pośrednictwem