Approvals - Query

Referenz

Dienst:: Approvals And Checks

API-Version:: 7.1

Genehmigungen auflisten. Dies kann verwendet werden, um eine Reihe 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

Mit optionalen Parametern:

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?approvalIds={approvalIds}&$expand={$expand}&userIds={userIds}&state={state}&top={top}&api-version=7.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" 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	Genehmigungsstatus. Gibt Genehmigungen eines Status zurück, wenn nicht angegeben
top	query		integer (int32)	Maximale Anzahl der abzurufenden Genehmigungen.
userIds	query		string (array (string))	Liste der Zugewiesenen Benutzer-ID-Genehmigungen. Akzeptiert entweder Benutzer-IDs oder Benutzerdeskriptoren.

Antworten

Name	Typ	Beschreibung
200 OK	Approval[]	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name	Beschreibung
vso.build	Gewährt die Möglichkeit, auf Buildartefakte zuzugreifen, einschließlich Buildergebnissen, Definitionen und Anforderungen sowie die Möglichkeit, Benachrichtigungen über Buildereignisse über Dienst-Hooks zu empfangen.

Beispiele

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 200

request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context

{
  "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 Aktionen ausführen können.
ApprovalPermissions	Aktuelle Benutzerberechtigungen für das Genehmigungsobjekt.
ApprovalStatus	Gesamtstatus 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-Referenzverknüpfungslinks darstellt.

Approval

Objekt

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 (date-time)	Datum, an dem die Genehmigung erstellt wurde.
executionOrder	ApprovalExecutionOrder	Reihenfolge, in der Genehmigende Aktionen ausführen können.
id	string (uuid)	Eindeutiger Bezeichner der Genehmigung.
instructions	string	Anweisungen für die Genehmigende.
lastModifiedOn	string (date-time)	Datum, an dem die Genehmigung zuletzt geändert wurde.
minRequiredApprovers	integer (int32)	Mindestanzahl von Genehmigenden, die die gesamte Genehmigung genehmigen sollten, die als genehmigt betrachtet werden soll.
permissions	ApprovalPermissions	Aktuelle Benutzerberechtigungen für das Genehmigungsobjekt.
status	ApprovalStatus	Gesamtstatus der Genehmigung.
steps	ApprovalStep[]	Liste der Schritte, die der Genehmigung zugeordnet sind.

ApprovalDetailsExpandParameter

Enumeration

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

Wert	Beschreibung
none	Keine zusätzlichen Eigenschaften.
permissions	Fügen Sie aktuelle Benutzerberechtigungen für das Genehmigungsobjekt hinzu.
steps	Schließen Sie genehmigungsschritte ein, die der Genehmigung zugeordnet sind.

ApprovalExecutionOrder

Enumeration

Reihenfolge, in der Genehmigende Aktionen ausführen können.

Wert	Beschreibung
anyOrder	Gibt an, dass die Genehmigenden in beliebiger Reihenfolge genehmigen können.
inSequence	Gibt an, dass die Genehmiger nur in einer sequenziellen Reihenfolge genehmigen können(Reihenfolge, in der sie zugewiesen wurden).

ApprovalPermissions

Enumeration

Aktuelle Benutzerberechtigungen für das Genehmigungsobjekt.

Wert	Beschreibung
none
queueBuild
reassign
resourceAdmin
update
view

ApprovalStatus

Enumeration

Gesamtstatus der Genehmigung.

Wert	Beschreibung
all
approved	Gibt an, dass die Genehmigung genehmigt wurde.
canceled	Gibt an, dass die Genehmigung abgebrochen wurde.
completed
failed
pending	Gibt an, dass die Genehmigung aussteht.
rejected	Gibt an, dass die Genehmigung abgelehnt wurde.
skipped	Gibt an, dass die Genehmigung übersprungen wird.
timedOut	Gibt an, dass die Genehmigung timed out ist.
undefined
uninitiated	Gibt an, dass die Genehmigung nicht aktiviert ist. Wird in Sequenzreihenfolge der Ausführung verwendet, wenn der genehmigende Benutzer noch nicht umsetzbar ist.

ApprovalStep

Objekt

Daten für einen einzelnen Genehmigungsschritt.

Name	Typ	Beschreibung
actualApprover	IdentityRef	Identität, die genehmigt wurde.
assignedApprover	IdentityRef	Identität, die genehmigt werden soll.
comment	string	Diesem Schritt zugeordneter Kommentar.
history	ApprovalStepHistory[]	Verlauf des Genehmigungsschritts
initiatedOn	string (date-time)	Zeitstempel, zu dem dieser Schritt initiiert wurde.
lastModifiedBy	IdentityRef	Identität, nach der dieser Schritt zuletzt geändert wurde.
lastModifiedOn	string (date-time)	Zeitstempel, zu dem dieser Schritt zuletzt geändert wurde.
order	integer (int32)	Reihenfolge, in der die Genehmigenden genehmigen dürfen.
permissions	ApprovalPermissions	Aktuelle Benutzerberechtigungen für Schritt.
status	ApprovalStatus	Aktueller Status dieses Schritts.

ApprovalStepHistory

Objekt

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 (date-time)	Zeitstempel, zu dem dieser Schrittverlauf erstellt wurde.

IdentityRef

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Thema Diagramm. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Diagrammbetreff zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Möglichkeit, auf den Diagrammbetreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird dasselbe Diagrammthema sowohl in Firmen als auch in Organisationen eindeutig identifiziert.
directoryAlias	string	Veraltet – Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im "Self"-Eintrag des IdentityRef -Wörterbuchs "_links" verwiesen wird
displayName	string	Dies ist der nicht eindeutige Anzeigename des Diagrammbetreffs. Um dieses Feld zu ändern, müssen Sie den Wert im Quellanbieter ändern.
id	string
imageUrl	string	Veraltet – Verfügbar im "Avatar"-Eintrag des IdentityRef-Wörterbuchs "_links"
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 – nicht in den meisten bereits vorhandenen Implementierungen von ToIdentityRef verwendet
uniqueName	string	Veraltet – Verwenden Sie stattdessen "Domain+PrincipalName".
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

ReferenceLinks

Objekt

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

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

Freigeben über

Approvals - Query

URI-Parameter

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Approval

ApprovalDetailsExpandParameter

ApprovalExecutionOrder

ApprovalPermissions

ApprovalStatus

ApprovalStep

ApprovalStepHistory

IdentityRef

ReferenceLinks

Zusätzliche Ressourcen