Approvals - Query

Referenz

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Listengenehmigungen. Dies kann verwendet werden, um einen Satz ausstehender Genehmigungen in einer Pipeline, für einen Benutzer oder für eine Ressource abzurufen.

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

With optional parameters:

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

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.1" festgelegt werden, um diese Version der API zu verwenden.
$expand	query		ApprovalDetailsExpandParameter	Fügen Sie diese zusätzlichen Details in die zurückgegebenen Objekte ein.
approvalIds	query		string array (uuid)	Liste der abzurufenden Genehmigungs-IDs.
state	query		ApprovalStatus	Genehmigung status. Gibt Genehmigungen für alle status zurück, wenn nicht angegeben
top	query		integer int32	Maximale Anzahl von Genehmigungen, die abgerufen werden sollen.
userIds	query		string array (string)	Liste der Benutzer-ID-Genehmigungen, die zugewiesen sind. Akzeptiert entweder Benutzer-IDs oder Benutzerdeskriptoren.

Antworten

Name	Typ	Beschreibung
200 OK	Approval[]	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.build	Ermöglicht den Zugriff auf Buildartefakte, einschließlich Buildergebnissen, Definitionen und Anforderungen, und die Möglichkeit, Benachrichtigungen über Buildereignisse über Diensthaken zu empfangen.

Beispiele

Sample Request

HTTP

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?approvalIds=ee14f612-6838-43c0-b445-db238ef14153,06239b11-a904-43a1-be6a-0d44026bd121&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

{
  "count": 2,
  "value": [
    {
      "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"
        }
      }
    },
    {
      "id": "06239b11-a904-43a1-be6a-0d44026bd121",
      "steps": [],
      "status": "pending",
      "createdOn": "2020-11-19T09:39:35.28Z",
      "lastModifiedOn": "2020-11-19T09:39:35.2806001Z",
      "executionOrder": "anyOrder",
      "minRequiredApprovers": 1,
      "blockedApprovers": [],
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/approvals/06239b11-a904-43a1-be6a-0d44026bd121"
        }
      }
    }
  ]
}

Definitionen

Name	Beschreibung
Approval
ApprovalDetailsExpandParameter	Fügen Sie diese zusätzlichen Details in die zurückgegebenen Objekte ein.
ApprovalExecutionOrder	Reihenfolge, in der genehmigende Personen umsetzbar sind.
ApprovalPermissions	Aktuelle Benutzerberechtigungen für das Genehmigungsobjekt.
ApprovalStatus	Gesamt status der Genehmigung.
ApprovalStep	Daten für einen einzelnen Genehmigungsschritt.
ApprovalStepHistory	Daten für einen einzelnen Genehmigungsschrittverlauf.
IdentityRef
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Approval

Name	Typ	Beschreibung
_links	ReferenceLinks	Ruft die Links für den Zugriff auf das Genehmigungsobjekt ab.
blockedApprovers	IdentityRef[]	Identitäten, die nicht genehmigt werden dürfen.
createdOn	string	Datum, an dem die Genehmigung erstellt wurde.
executionOrder	ApprovalExecutionOrder	Reihenfolge, in der genehmigende Personen umsetzbar sind.
id	string	Eindeutiger Bezeichner der Genehmigung.
instructions	string	Anweisungen für die genehmigenden Personen.
lastModifiedOn	string	Datum, an dem die Genehmigung zuletzt geändert wurde.
minRequiredApprovers	integer	Mindestanzahl der genehmigenden Personen, die genehmigen sollten, damit die gesamte Genehmigung als genehmigt betrachtet wird.
permissions	ApprovalPermissions	Aktuelle Benutzerberechtigungen für das Genehmigungsobjekt.
status	ApprovalStatus	Gesamt status der Genehmigung.
steps	ApprovalStep[]	Liste der Schritte, die der Genehmigung zugeordnet sind.

ApprovalDetailsExpandParameter

Fügen Sie diese zusätzlichen Details in die zurückgegebenen Objekte ein.

Name	Typ	Beschreibung
none	string	Keine zusätzlichen Eigenschaften.
permissions	string	Schließen Sie aktuelle Benutzerberechtigungen für das Genehmigungsobjekt ein.
steps	string	Schließen Sie Genehmigungsschritte ein, die der Genehmigung zugeordnet sind.

ApprovalExecutionOrder

Reihenfolge, in der genehmigende Personen umsetzbar sind.

Name	Typ	Beschreibung
anyOrder	string	Gibt an, dass die genehmigenden Personen in beliebiger Reihenfolge genehmigen können.
inSequence	string	Gibt an, dass die genehmigenden Personen nur in einer sequenziellen Reihenfolge (Reihenfolge, in der sie zugewiesen wurden) genehmigen können.

ApprovalPermissions

Aktuelle Benutzerberechtigungen für das Genehmigungsobjekt.

Name	Typ	Beschreibung
none	string
queueBuild	string
reassign	string
resourceAdmin	string
update	string
view	string

ApprovalStatus

Gesamt status der Genehmigung.

Name	Typ	Beschreibung
all	string
approved	string	Gibt an, dass die Genehmigung genehmigt ist.
canceled	string	Gibt an, dass die Genehmigung abgebrochen ist.
completed	string
failed	string
pending	string	Gibt an, dass die Genehmigung ausstehend ist.
rejected	string	Gibt an, dass die Genehmigung abgelehnt wird.
skipped	string	Gibt an, dass die Genehmigung übersprungen ist.
timedOut	string	Gibt an, dass die Genehmigung ein Timeout hat.
undefined	string
uninitiated	string	Gibt an, dass die Genehmigung nicht eingeweiht ist. Wird verwendet, wenn die Reihenfolge der Ausführung erfolgt, bei der ein genehmigenden Benutzer noch nicht verwertbar ist.

ApprovalStep

Daten für einen einzelnen Genehmigungsschritt.

Name	Typ	Beschreibung
actualApprover	IdentityRef	Identität, die genehmigt hat.
assignedApprover	IdentityRef	Identität, die genehmigen soll.
comment	string	Kommentar, der diesem Schritt zugeordnet ist.
history	ApprovalStepHistory[]	Verlauf des Genehmigungsschritts
initiatedOn	string	Zeitstempel, zu dem dieser Schritt initiiert wurde.
lastModifiedBy	IdentityRef	Identität, mit der dieser Schritt zuletzt geändert wurde.
lastModifiedOn	string	Zeitstempel, zu dem dieser Schritt zuletzt geändert wurde.
order	integer	Reihenfolge, in der die genehmigenden Personen genehmigen dürfen.
permissions	ApprovalPermissions	Aktuelle Benutzerberechtigungen für Schritt.
status	ApprovalStatus	Aktuelle status dieses Schritts.

ApprovalStepHistory

Daten für einen einzelnen Genehmigungsschrittverlauf.

Name	Typ	Beschreibung
assignedTo	IdentityRef	Identität, der diese Genehmigung zugewiesen wurde
comment	string	Kommentar, der diesem Schrittverlauf zugeordnet ist.
createdBy	IdentityRef	Identität, mit der dieser Schrittverlauf erstellt wurde.
createdOn	string	Zeitstempel, zu dem dieser Schrittverlauf erstellt wurde.

IdentityRef

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Diagrammthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graph-Thema zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Möglichkeit, auf den Graphengegenstand 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 "selbst" des IdentityRef-Wörterbuchs "_links" verwiesen wird.
displayName	string	Dies ist der nicht eindeutige Anzeigename des Diagrammsubjekts. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.
id	string
imageUrl	string	Veraltet: Verfügbar im Eintrag "avatar" des IdentityRef-Wörterbuchs "_links"
inactive	boolean	Veraltet: Kann durch Abfragen des Graph-Mitgliedschaftsstatus abgerufen werden, 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 bereits 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.

ReferenceLinks

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

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