Approvals - Update

Odwołanie

Usługa:: Approvals And Checks

Wersja interfejsu API:: 7.1

Aktualizowanie zatwierdzeń.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
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. Należy ustawić wartość "7.1", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
body	ApprovalUpdateParameters[]

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Approval[]	operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

Nazwa	Opis
vso.build_execute	Umożliwia dostęp do artefaktów kompilacji, w tym wyników kompilacji, definicji i żądań oraz możliwość kolejkowania kompilacji, aktualizowania właściwości kompilacji oraz odbierania powiadomień o zdarzeniach kompilacji za pośrednictwem punktów zaczepienia usługi.
vso.pipelineresources_use	Przyznaje możliwość zatwierdzenia żądania potoku w celu użycia chronionego zasobu: pula agentów, środowisko, kolejka, repozytorium, bezpieczne pliki, połączenie z usługą i grupa zmiennych

Przykłady

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
        }
      }
    }
  ]
}

Definicje

Nazwa	Opis
Approval
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.
ApprovalUpdateParameters	Dane w celu zaktualizowania obiektu zatwierdzenia lub jego pojedynczego kroku.
IdentityRef
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.

Approval

Objekt

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

ApprovalExecutionOrder

Wyliczanie

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

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

ApprovalPermissions

Wyliczanie

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

Wartość	Opis
none
queueBuild
reassign
resourceAdmin
update
view

ApprovalStatus

Wyliczanie

Ogólny stan zatwierdzenia.

Wartość	Opis
all
approved	Wskazuje, że zatwierdzenie jest zatwierdzone.
canceled	Wskazuje, że zatwierdzenie zostało anulowane.
completed
failed
pending	Wskazuje, że zatwierdzenie jest oczekujące.
rejected	Wskazuje, że zatwierdzenie zostało odrzucone.
skipped	Wskazuje, że zatwierdzenie zostało pominięte.
timedOut	Wskazuje, że zatwierdzenie jest przekroczone limit czasu.
undefined
uninitiated	Wskazuje, że zatwierdzenie jest nie zainicjowane. Używane w przypadku w kolejności wykonywania w kolejności, w której dana osoba zatwierdzająca nie może jeszcze wykonywać akcji.

ApprovalStep

Objekt

Dane dla pojedynczego kroku zatwierdzania.

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

ApprovalStepHistory

Objekt

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 (date-time)	Sygnatura czasowa, w której została utworzona ta historia kroków.

ApprovalUpdateParameters

Objekt

Dane w celu zaktualizowania obiektu zatwierdzenia lub jego pojedynczego kroku.

Nazwa	Typ	Opis
approvalId	string (uuid)	Identyfikator zatwierdzenia do zaktualizowania.
assignedApprover	IdentityRef	Bieżący osoba zatwierdzająca.
comment	string	Pobiera lub ustawia komentarz.
reassignTo	IdentityRef	Ponownie przypisano osoba zatwierdzająca.
status	ApprovalStatus	Pobiera lub ustawia stan.

IdentityRef

Objekt

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łowania 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 go 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 unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, musisz 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 głównej i domeny
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

ReferenceLinks

Objekt

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

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

Udostępnij przez

Approvals - Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

oauth2

Zakresy

Przykłady

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Approval

ApprovalExecutionOrder

ApprovalPermissions

ApprovalStatus

ApprovalStep

ApprovalStepHistory

ApprovalUpdateParameters

IdentityRef

ReferenceLinks