Approvals - Update

Referenz

Service:: Release

API Version:: 5.0

Aktualisieren status einer Genehmigung

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
approvalId	path	True	integer int32	ID der Genehmigung.
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path	True	string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "5.0" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name	Typ	Beschreibung
approvalType	ApprovalType	Ruft den Genehmigungstyp ab oder legt diese fest.
approvedBy	IdentityRef	Ruft die Identität ab, die genehmigt hat.
approver	IdentityRef	Ruft die Identität ab, die genehmigen soll, oder legt sie fest.
attempt	integer	Ruft den Versuch ab, der angibt, zu welchem Bereitstellungsversuch er gehört, oder legt ihn fest.
comments	string	Ruft Kommentare zur Genehmigung ab oder legt diese fest.
createdOn	string	Ruft das Erstellungsdatum ab.
history	ReleaseApprovalHistory[]	Ruft den Verlauf ab, der alle Genehmigungen angibt, die dieser Genehmigung zugeordnet sind.
id	integer	Ruft den eindeutigen Bezeichner dieses Felds ab.
isAutomated	boolean	Ruft ab oder legt fest, ob die Genehmigung automatisiert ist oder nicht.
isNotificationOn	boolean
modifiedOn	string	Ruft das Datum ab, an dem er geändert wurde.
rank	integer	Ruft den Rang ab, der die Reihenfolge der Genehmigung angibt, oder legt diese fest. z. B. bezeichnet die gleiche Rangfolge die parallele Genehmigung.
release	ReleaseShallowReference	Ruft releaseReference ab, das den Verweis auf das Release angibt, dem diese Genehmigung zugeordnet ist.
releaseDefinition	ReleaseDefinitionShallowReference	Ruft releaseDefinitionReference ab, das den Verweis auf die Releasedefinition angibt, der diese Genehmigung zugeordnet ist.
releaseEnvironment	ReleaseEnvironmentShallowReference	Ruft releaseEnvironmentReference ab, das den Verweis auf die Releaseumgebung angibt, der diese Genehmigung zugeordnet ist.
revision	integer	Ruft die Revisionsnummer ab.
status	ApprovalStatus	Ruft den status der Genehmigung ab oder legt diese fest.
trialNumber	integer
url	string	Ruft die URL für den Zugriff auf die Genehmigung ab.

Antworten

Name	Typ	Beschreibung
200 OK	ReleaseApproval	Erfolgreicher Vorgang

Sicherheit

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

Name	Beschreibung
vso.release_manage	Ermöglicht das Lesen, Aktualisieren und Löschen von Releaseartefakten, einschließlich Releases, Releasedefinitionen und Releasedefinitionen sowie die Möglichkeit, eine neue Version in die Warteschlange zu stellen und zu genehmigen.

Beispiele

Approve a release

Sample Request

HTTP

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

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

Sample Response

Status code:: 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://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/releases/3",
    "_links": {}
  },
  "releaseDefinition": {
    "id": 1,
    "name": "MyShuttle.CD",
    "url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
    "_links": {}
  },
  "releaseEnvironment": {
    "id": 9,
    "name": "Dev",
    "_links": {}
  },
  "url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/approvals/20"
}

Definitionen

Name	Beschreibung
ApprovalStatus	Ruft den status der Genehmigung ab oder legt diese fest.
ApprovalType	Ruft den Genehmigungstyp ab oder legt diese fest.
IdentityRef
ProjectReference
ReferenceLinks	Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.
ReleaseApproval
ReleaseApprovalHistory
ReleaseDefinitionShallowReference
ReleaseEnvironmentShallowReference
ReleaseShallowReference

ApprovalStatus

Ruft den status der Genehmigung ab oder legt diese fest.

Name	Typ	Beschreibung
approved	string
canceled	string
pending	string
reassigned	string
rejected	string
skipped	string
undefined	string

ApprovalType

Ruft den Genehmigungstyp ab oder legt diese fest.

Name	Typ	Beschreibung
all	string
postDeploy	string
preDeploy	string
undefined	string

IdentityRef

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Graphthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graphthema zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Methode, um auf den Graph-Betreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert.
directoryAlias	string
displayName	string	Dies ist der nicht eindeutige Anzeigename des Graph-Betreffs. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

ProjectReference

Name	Typ	Beschreibung
id	string	Ruft den eindeutigen Bezeichner dieses Felds ab.
name	string	Ruft den Namen des Projekts ab.

ReferenceLinks

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützter Sind, möchten wir sie nur als schreibgeschützter Link verfügbar machen.

ReleaseApproval

Name	Typ	Beschreibung
approvalType	ApprovalType	Ruft den Genehmigungstyp ab oder legt diese fest.
approvedBy	IdentityRef	Ruft die Identität ab, die genehmigt hat.
approver	IdentityRef	Ruft die Identität ab, die genehmigen soll, oder legt sie fest.
attempt	integer	Ruft den Versuch ab, der angibt, zu welchem Bereitstellungsversuch er gehört, oder legt ihn fest.
comments	string	Ruft Kommentare zur Genehmigung ab oder legt diese fest.
createdOn	string	Ruft das Erstellungsdatum ab.
history	ReleaseApprovalHistory[]	Ruft den Verlauf ab, der alle Genehmigungen angibt, die dieser Genehmigung zugeordnet sind.
id	integer	Ruft den eindeutigen Bezeichner dieses Felds ab.
isAutomated	boolean	Ruft ab oder legt fest, ob die Genehmigung automatisiert ist oder nicht.
isNotificationOn	boolean
modifiedOn	string	Ruft das Datum ab, an dem er geändert wurde.
rank	integer	Ruft den Rang ab, der die Reihenfolge der Genehmigung angibt, oder legt diese fest. z. B. bezeichnet die gleiche Rangfolge die parallele Genehmigung.
release	ReleaseShallowReference	Ruft releaseReference ab, das den Verweis auf das Release angibt, dem diese Genehmigung zugeordnet ist.
releaseDefinition	ReleaseDefinitionShallowReference	Ruft releaseDefinitionReference ab, das den Verweis auf die Releasedefinition angibt, der diese Genehmigung zugeordnet ist.
releaseEnvironment	ReleaseEnvironmentShallowReference	Ruft releaseEnvironmentReference ab, das den Verweis auf die Releaseumgebung angibt, der diese Genehmigung zugeordnet ist.
revision	integer	Ruft die Revisionsnummer ab.
status	ApprovalStatus	Ruft den status der Genehmigung ab oder legt diese fest.
trialNumber	integer
url	string	Ruft die URL für den Zugriff auf die Genehmigung ab.

ReleaseApprovalHistory

Name	Typ	Beschreibung
approver	IdentityRef
changedBy	IdentityRef
comments	string
createdOn	string
modifiedOn	string
revision	integer

ReleaseDefinitionShallowReference

Name	Typ	Beschreibung
_links	ReferenceLinks	Ruft die Links zu verwandten Ressourcen, APIs und Ansichten für die Releasedefinition ab.
id	integer	Ruft den eindeutigen Bezeichner der Releasedefinition ab.
name	string	Ruft den Namen der Releasedefinition ab oder legt den Namen fest.
path	string	Ruft den Pfad der Releasedefinition ab oder legt den Pfad fest.
projectReference	ProjectReference	Ruft den Projektverweis ab oder legt diese fest.
url	string	Ruft die REST-API-URL für den Zugriff auf die Releasedefinition ab.

ReleaseEnvironmentShallowReference

Name	Typ	Beschreibung
_links	ReferenceLinks	Ruft die Links zu verwandten Ressourcen, APIs und Ansichten für die Releaseumgebung ab.
id	integer	Ruft den eindeutigen Bezeichner der Releaseumgebung ab.
name	string	Ruft den Namen der Releaseumgebung ab oder legt den Namen fest.
url	string	Ruft die REST-API-URL für den Zugriff auf die Releaseumgebung ab.

ReleaseShallowReference

Name	Typ	Beschreibung
_links	ReferenceLinks	Ruft die Links zu verwandten Ressourcen, APIs und Ansichten für das Release ab.
id	integer	Ruft den eindeutigen Bezeichner des Release ab.
name	string	Ruft den Namen des Release ab oder legt den Namen des Release fest.
url	string	Ruft die REST-API-URL für den Zugriff auf das Release ab.

Freigeben über