Approvals - Update

Odwołanie

Usługa:: Release

Wersja interfejsu API:: 7.1

Aktualizowanie stanu zatwierdzenia

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

Parametry identyfikatora URI

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

Treść żądania

Nazwa	Typ	Opis
approvalType	ApprovalType	Pobiera lub ustawia typ zatwierdzenia.
approvedBy	IdentityRef	Pobiera tożsamość, która zatwierdziła.
approver	IdentityRef	Pobiera lub ustawia tożsamość, która powinna zostać zatwierdzana.
attempt	integer (int32)	Pobiera lub ustawia próbę, która określa, do której próby wdrożenia należy.
comments	string	Pobiera lub ustawia komentarze do zatwierdzenia.
createdOn	string (date-time)	Pobiera datę utworzenia.
history	ReleaseApprovalHistory[]	Pobiera historię określającą wszystkie zatwierdzenia skojarzone z tym zatwierdzeniem.
id	integer (int32)	Pobiera unikatowy identyfikator tego pola.
isAutomated	boolean	Pobiera lub ustawia jako zatwierdzenie jest zautomatyzowane lub nie.
modifiedOn	string (date-time)	Pobiera datę modyfikacji.
rank	integer (int32)	Pobiera lub ustawia rangę, która określa kolejność zatwierdzenia. Na przykład ta sama ranga oznacza zatwierdzenie równoległe.
release	ReleaseShallowReference	Pobiera releaseReference, który określa odwołanie do wydania, do którego jest skojarzone to zatwierdzenie.
releaseDefinition	ReleaseDefinitionShallowReference	Pobiera wartość releaseDefinitionReference, która określa odwołanie do definicji wydania, z którą jest skojarzone to zatwierdzenie.
releaseEnvironment	ReleaseEnvironmentShallowReference	Pobiera releaseEnvironmentReference, który określa odwołanie do środowiska wydania, z którym jest skojarzone to zatwierdzenie.
revision	integer (int32)	Pobiera numer poprawki.
status	ApprovalStatus	Pobiera lub ustawia stan zatwierdzenia.
url	string	Pobiera adres URL w celu uzyskania dostępu do zatwierdzenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ReleaseApproval	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.release_manage	Daje możliwość odczytywania, aktualizowania i usuwania artefaktów wydania, w tym folderów, wydań, definicji wydania i środowiska wydania oraz możliwości kolejkowania i zatwierdzania nowej wersji.

Przykłady

Approve a release

Przykładowe żądanie

HTTP

PATCH https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/approvals/{approvalId}?api-version=7.1

{
  "status": "approved",
  "comments": "Good to go!"
}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "id": 20,
  "revision": 1,
  "approver": {
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabfiber@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
  },
  "approvedBy": {
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabfiber@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
  },
  "approvalType": "preDeploy",
  "createdOn": "2017-05-31T18:07:40.45Z",
  "modifiedOn": "2017-05-31T18:08:09.577Z",
  "status": "approved",
  "comments": "Good to go!",
  "isAutomated": false,
  "isNotificationOn": true,
  "trialNumber": 1,
  "attempt": 1,
  "rank": 1,
  "history": [],
  "release": {
    "id": 3,
    "name": "Release-3",
    "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/releases/3",
    "_links": {}
  },
  "releaseDefinition": {
    "id": 1,
    "name": "MyShuttle.CD",
    "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
    "_links": {}
  },
  "releaseEnvironment": {
    "id": 9,
    "name": "Dev",
    "_links": {}
  },
  "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/approvals/20"
}

Definicje

Nazwa	Opis
ApprovalStatus	Pobiera lub ustawia stan zatwierdzenia.
ApprovalType	Pobiera lub ustawia typ zatwierdzenia.
IdentityRef
ProjectReference
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
ReleaseApproval
ReleaseApprovalHistory
ReleaseDefinitionShallowReference
ReleaseEnvironmentShallowReference
ReleaseShallowReference

ApprovalStatus

Wyliczanie

Pobiera lub ustawia stan zatwierdzenia.

Wartość	Opis
approved	Wskazuje, że zatwierdzenie zostało zatwierdzone.
canceled	Wskazuje, że zatwierdzenie zostało anulowane.
pending	Wskazuje, że zatwierdzenie oczekuje.
reassigned	Wskazuje, że zatwierdzenie jest ponownie przypisywane.
rejected	Wskazuje, że zatwierdzenie zostało odrzucone.
skipped	Wskazuje, że zatwierdzenie zostało pominięte.
undefined	Wskazuje, że zatwierdzenie nie ma ustawionego stanu.

ApprovalType

Wyliczanie

Pobiera lub ustawia typ zatwierdzenia.

Wartość	Opis
all	Wskazuje wszystkie zatwierdzenia.
postDeploy	Wskazuje zatwierdzenia wykonywane po wdrożeniu.
preDeploy	Wskazuje zatwierdzenia wykonywane przed wdrożeniem.
undefined	Wskazuje, że typ zatwierdzenia nie jest ustawiony.

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.

ProjectReference

Objekt

Nazwa	Typ	Opis
id	string (uuid)	Pobiera unikatowy identyfikator tego pola.
name	string	Pobiera nazwę projektu.

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.

ReleaseApproval

Objekt

Nazwa	Typ	Opis
approvalType	ApprovalType	Pobiera lub ustawia typ zatwierdzenia.
approvedBy	IdentityRef	Pobiera tożsamość, która zatwierdziła.
approver	IdentityRef	Pobiera lub ustawia tożsamość, która powinna zostać zatwierdzana.
attempt	integer (int32)	Pobiera lub ustawia próbę, która określa, do której próby wdrożenia należy.
comments	string	Pobiera lub ustawia komentarze do zatwierdzenia.
createdOn	string (date-time)	Pobiera datę utworzenia.
history	ReleaseApprovalHistory[]	Pobiera historię określającą wszystkie zatwierdzenia skojarzone z tym zatwierdzeniem.
id	integer (int32)	Pobiera unikatowy identyfikator tego pola.
isAutomated	boolean	Pobiera lub ustawia jako zatwierdzenie jest zautomatyzowane lub nie.
modifiedOn	string (date-time)	Pobiera datę modyfikacji.
rank	integer (int32)	Pobiera lub ustawia rangę, która określa kolejność zatwierdzenia. Na przykład ta sama ranga oznacza zatwierdzenie równoległe.
release	ReleaseShallowReference	Pobiera releaseReference, który określa odwołanie do wydania, do którego jest skojarzone to zatwierdzenie.
releaseDefinition	ReleaseDefinitionShallowReference	Pobiera wartość releaseDefinitionReference, która określa odwołanie do definicji wydania, z którą jest skojarzone to zatwierdzenie.
releaseEnvironment	ReleaseEnvironmentShallowReference	Pobiera releaseEnvironmentReference, który określa odwołanie do środowiska wydania, z którym jest skojarzone to zatwierdzenie.
revision	integer (int32)	Pobiera numer poprawki.
status	ApprovalStatus	Pobiera lub ustawia stan zatwierdzenia.
url	string	Pobiera adres URL w celu uzyskania dostępu do zatwierdzenia.

ReleaseApprovalHistory

Objekt

Nazwa	Typ	Opis
approver	IdentityRef	Tożsamość osoby zatwierdzającej.
changedBy	IdentityRef	Tożsamość obiektu, który zmienił zatwierdzenie.
comments	string	Komentarze historii zatwierdzania.
createdOn	string (date-time)	Czas utworzenia tego zatwierdzenia.
modifiedOn	string (date-time)	Czas modyfikacji tego zatwierdzenia.
revision	integer (int32)	Poprawka historii zatwierdzania.

ReleaseDefinitionShallowReference

Objekt

Nazwa	Typ	Opis
_links	ReferenceLinks	Pobiera linki do powiązanych zasobów, interfejsów API i widoków definicji wydania.
id	integer (int32)	Pobiera unikatowy identyfikator definicji wydania.
name	string	Pobiera lub ustawia nazwę definicji wydania.
path	string	Pobiera lub ustawia ścieżkę definicji wydania.
projectReference	ProjectReference	Pobiera lub ustawia odwołanie do projektu.
url	string	Pobiera adres URL interfejsu API REST w celu uzyskania dostępu do definicji wydania.

ReleaseEnvironmentShallowReference

Objekt

Nazwa	Typ	Opis
_links	ReferenceLinks	Pobiera linki do powiązanych zasobów, interfejsów API i widoków środowiska wydania.
id	integer (int32)	Pobiera unikatowy identyfikator środowiska wydania.
name	string	Pobiera lub ustawia nazwę środowiska wydania.
url	string	Pobiera adres URL interfejsu API REST w celu uzyskania dostępu do środowiska wydania.

ReleaseShallowReference

Objekt

Nazwa	Typ	Opis
_links	ReferenceLinks	Pobiera linki do powiązanych zasobów, interfejsów API i widoków dla wydania.
id	integer (int32)	Pobiera unikatowy identyfikator wydania.
name	string	Pobiera lub ustawia nazwę wydania.
url	string	Pobiera adres URL interfejsu API REST w celu uzyskania dostępu do wersji.

Udostępnij przez

Approvals - Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

oauth2

Zakresy

Przykłady

Approve a release

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ApprovalStatus

ApprovalType

IdentityRef

ProjectReference

ReferenceLinks

ReleaseApproval

ReleaseApprovalHistory

ReleaseDefinitionShallowReference

ReleaseEnvironmentShallowReference

ReleaseShallowReference