Approvals - List

Referenz

Service:: Release

API Version:: 7.1-preview.3

Abrufen einer Liste der Genehmigungen

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

With optional parameters:

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/approvals?assignedToFilter={assignedToFilter}&statusFilter={statusFilter}&releaseIdsFilter={releaseIdsFilter}&typeFilter={typeFilter}&top={top}&continuationToken={continuationToken}&queryOrder={queryOrder}&includeMyGroupApprovals={includeMyGroupApprovals}&api-version=7.1-preview.3

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
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 "7.1-preview.3" festgelegt werden, um diese Version der API zu verwenden.
assignedToFilter	query		string	Diesem Benutzer zugewiesene Genehmigungen.
continuationToken	query		integer int32	Ruft die Genehmigungen nach dem bereitgestellten Fortsetzungstoken ab.
includeMyGroupApprovals	query		boolean	"true", um meine Gruppengenehmigungen einzuschließen. Der Standardwert ist "false".
queryOrder	query		ReleaseQueryOrder	Ruft die Ergebnisse in der definierten Reihenfolge der erstellten Genehmigungen ab. Der Standardwert ist "absteigend".
releaseIdsFilter	query		string array (int32)	Genehmigungen für release-IDs, die im Filter erwähnt werden. Mehrere Releases können erwähnt werden, indem Sie sie durch "," trennen, z. B. releaseIdsFilter=1,2,3,4.
statusFilter	query		ApprovalStatus	Genehmigungen mit diesem status. Der Standardwert ist "ausstehend".
top	query		integer int32	Anzahl der zu erhaltenden Genehmigungen. Standard ist 50.
typeFilter	query		ApprovalType	Genehmigung mit diesem Typ.

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	Ermöglicht das Lesen von Releaseartefakten, einschließlich Ordnern, Releases, Releasedefinitionen und Releaseumgebungen.

Beispiele

Pending for a specific release

Pending for a specific user

Pending for all users

Pending for a specific release

Sample Request

HTTP

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/approvals?releaseIdsFilter=14&continuationToken=0&api-version=7.1-preview.3

Sample Response

Status code:: 200

{
  "count": 1,
  "value": [
    {
      "id": 134,
      "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"
      },
      "approvalType": "preDeploy",
      "createdOn": "2017-06-01T09:42:16.053Z",
      "modifiedOn": "2017-06-01T09:42:16.053Z",
      "status": "pending",
      "comments": "",
      "isAutomated": false,
      "isNotificationOn": true,
      "trialNumber": 1,
      "attempt": 1,
      "rank": 1,
      "release": {
        "id": 14,
        "name": "Release-14",
        "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/releases/14",
        "_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": 53,
        "name": "Dev",
        "_links": {}
      },
      "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/approvals/134"
    }
  ]
}

Pending for a specific user

Sample Request

HTTP

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/approvals?assignedToFilter=Chuck Reinhart&continuationToken=0&api-version=7.1-preview.3

Sample Response

Status code:: 200

{
  "count": 2,
  "value": [
    {
      "id": 2,
      "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"
      },
      "approvalType": "preDeploy",
      "createdOn": "2017-05-31T16:40:14.47Z",
      "modifiedOn": "2017-05-31T16:40:14.47Z",
      "status": "pending",
      "comments": "",
      "isAutomated": false,
      "isNotificationOn": true,
      "trialNumber": 1,
      "attempt": 1,
      "rank": 1,
      "release": {
        "id": 2,
        "name": "Release-2",
        "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/releases/2",
        "_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": 5,
        "name": "Dev",
        "_links": {}
      },
      "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/approvals/2"
    },
    {
      "id": 1,
      "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"
      },
      "approvalType": "preDeploy",
      "createdOn": "2017-05-31T16:40:04.577Z",
      "modifiedOn": "2017-05-31T16:40:04.577Z",
      "status": "pending",
      "comments": "",
      "isAutomated": false,
      "isNotificationOn": true,
      "trialNumber": 1,
      "attempt": 1,
      "rank": 1,
      "release": {
        "id": 1,
        "name": "Release-1",
        "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/releases/1",
        "_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": 1,
        "name": "Dev",
        "_links": {}
      },
      "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/approvals/1"
    }
  ]
}

Pending for all users

Sample Request

HTTP

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/approvals?continuationToken=0&api-version=7.1-preview.3

Sample Response

Status code:: 200

{
  "count": 2,
  "value": [
    {
      "id": 2,
      "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"
      },
      "approvalType": "preDeploy",
      "createdOn": "2017-05-31T16:40:14.47Z",
      "modifiedOn": "2017-05-31T16:40:14.47Z",
      "status": "pending",
      "comments": "",
      "isAutomated": false,
      "isNotificationOn": true,
      "trialNumber": 1,
      "attempt": 1,
      "rank": 1,
      "release": {
        "id": 2,
        "name": "Release-2",
        "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/releases/2",
        "_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": 5,
        "name": "Dev",
        "_links": {}
      },
      "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/approvals/2"
    },
    {
      "id": 1,
      "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"
      },
      "approvalType": "preDeploy",
      "createdOn": "2017-05-31T16:40:04.577Z",
      "modifiedOn": "2017-05-31T16:40:04.577Z",
      "status": "pending",
      "comments": "",
      "isAutomated": false,
      "isNotificationOn": true,
      "trialNumber": 1,
      "attempt": 1,
      "rank": 1,
      "release": {
        "id": 1,
        "name": "Release-1",
        "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/releases/1",
        "_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": 1,
        "name": "Dev",
        "_links": {}
      },
      "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/approvals/1"
    }
  ]
}

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
ReleaseQueryOrder	Ruft die Ergebnisse in der definierten Reihenfolge der erstellten Genehmigungen ab. Der Standardwert ist "absteigend".
ReleaseShallowReference

ApprovalStatus

Ruft den status der Genehmigung ab oder legt diese fest.

Name	Typ	Beschreibung
approved	string	Gibt an, dass die Genehmigung genehmigt wurde.
canceled	string	Gibt an, dass die Genehmigung abgebrochen wurde.
pending	string	Gibt an, dass die Genehmigung aussteht.
reassigned	string	Gibt an, dass die Genehmigung neu zugewiesen wurde.
rejected	string	Gibt an, dass die Genehmigung abgelehnt wird.
skipped	string	Gibt an, dass die Genehmigung übersprungen wurde.
undefined	string	Gibt an, dass die status für die Genehmigung nicht festgelegt ist.

ApprovalType

Ruft den Genehmigungstyp ab oder legt diese fest.

Name	Typ	Beschreibung
all	string	Gibt alle Genehmigungen an.
postDeploy	string	Gibt die Genehmigungen an, die nach der Bereitstellung ausgeführt wurden.
preDeploy	string	Gibt die Genehmigungen an, die vor der Bereitstellung ausgeführt wurden.
undefined	string	Gibt an, dass der Genehmigungstyp nicht festgelegt wird.

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	Veraltet: Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im Eintrag "self" des IdentityRef-Wörterbuchs "_links" verwiesen wird.
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	Veraltet: Im Eintrag "avatar" des IdentityRef-Wörterbuchs "_links" verfügbar
inactive	boolean	Veraltet: Kann abgerufen werden, indem der Graph-Mitgliedschaftsstatus abgefragt wird, auf den im Eintrag "membershipState" des GraphUser-Wörterbuchs "_links" verwiesen wird.
isAadIdentity	boolean	Veraltet: Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Veraltet: Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Veraltet– wird in den meisten vorhandenen Implementierungen von ToIdentityRef nicht verwendet.
uniqueName	string	Veraltet: Verwenden Sie stattdessen Domain+PrincipalName.
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.
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.
url	string	Ruft die URL für den Zugriff auf die Genehmigung ab.

ReleaseApprovalHistory

Name	Typ	Beschreibung
approver	IdentityRef	Identität der genehmigenden Person.
changedBy	IdentityRef	Identität des Objekts, das die Genehmigung geändert hat.
comments	string	Genehmigungsverlaufskommentare.
createdOn	string	Zeitpunkt, zu dem diese Genehmigung erstellt wurde.
modifiedOn	string	Zeitpunkt, zu dem diese Genehmigung geändert wurde.
revision	integer	Überarbeitung des Genehmigungsverlaufs.

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.

ReleaseQueryOrder

Ruft die Ergebnisse in der definierten Reihenfolge der erstellten Genehmigungen ab. Der Standardwert ist "absteigend".

Name	Typ	Beschreibung
ascending	string	Gibt Ergebnisse in aufsteigender Reihenfolge zurück.
descending	string	Gibt Ergebnisse in absteigender Reihenfolge zurück.

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

Approvals - List

URI-Parameter

Antworten

Sicherheit

oauth2

Scopes

Beispiele

Pending for a specific release

Sample Request

Sample Response

Pending for a specific user

Sample Request

Sample Response

Pending for all users

Sample Request

Sample Response

Definitionen

ApprovalStatus

ApprovalType

IdentityRef

ProjectReference

ReferenceLinks

ReleaseApproval

ReleaseApprovalHistory

ReleaseDefinitionShallowReference

ReleaseEnvironmentShallowReference

ReleaseQueryOrder

ReleaseShallowReference

Feedback

Zusätzliche Ressourcen