Partager via


Approvals - Query

Répertorier les approbations. Cela peut être utilisé pour obtenir un ensemble d’approbations en attente dans un pipeline, sur un utilisateur ou pour une ressource..

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?api-version=7.1-preview.1
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

Paramètres URI

Nom Dans Obligatoire Type Description
organization
path True

string

Nom de l’organisation Azure DevOps.

project
path True

string

ID de projet ou nom du projet

api-version
query True

string

Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.1 » pour utiliser cette version de l’API.

$expand
query

ApprovalDetailsExpandParameter

Incluez ces détails supplémentaires dans les objets retournés.

approvalIds
query

string

array (uuid)

Liste des ID d’approbation à obtenir.

state
query

ApprovalStatus

Status d’approbation. Retourne les approbations de n’importe quel status s’il n’est pas fourni

top
query

integer

int32

Nombre maximal d’approbations à obtenir.

userIds
query

string

array (string)

Liste des approbations d’ID utilisateur affectées à. Accepte les ID utilisateur ou les descripteurs d’utilisateur.

Réponses

Nom Type Description
200 OK

Approval[]

opération réussie

Sécurité

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

Nom Description
vso.build Accorde la possibilité d’accéder aux artefacts de build, y compris les résultats de build, les définitions et les demandes, et la possibilité de recevoir des notifications sur les événements de build via des hooks de service.

Exemples

Sample Request

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

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"
        }
      }
    }
  ]
}

Définitions

Nom Description
Approval
ApprovalDetailsExpandParameter

Incluez ces détails supplémentaires dans les objets retournés.

ApprovalExecutionOrder

Ordre dans lequel les approbateurs peuvent être actionnables.

ApprovalPermissions

Autorisations utilisateur actuelles pour l’objet d’approbation.

ApprovalStatus

Status globale de l’approbation.

ApprovalStep

Données d’une étape d’approbation unique.

ApprovalStepHistory

Données pour un historique d’étapes d’approbation unique.

IdentityRef
ReferenceLinks

Classe pour représenter une collection de liens de référence REST.

Approval

Nom Type Description
_links

ReferenceLinks

Obtient les liens permettant d’accéder à l’objet d’approbation.

blockedApprovers

IdentityRef[]

Identités qui ne sont pas autorisées à approuver.

createdOn

string

Date à laquelle l’approbation a été créée.

executionOrder

ApprovalExecutionOrder

Ordre dans lequel les approbateurs peuvent être actionnables.

id

string

Identificateur unique de l’approbation.

instructions

string

Instructions pour les approbateurs.

lastModifiedOn

string

Date de la dernière modification de l’approbation.

minRequiredApprovers

integer

Nombre minimal d’approbateurs qui doivent approuver pour que l’approbation entière soit considérée comme approuvée.

permissions

ApprovalPermissions

Autorisations utilisateur actuelles pour l’objet d’approbation.

status

ApprovalStatus

Status globale de l’approbation.

steps

ApprovalStep[]

Liste des étapes associées à l’approbation.

ApprovalDetailsExpandParameter

Incluez ces détails supplémentaires dans les objets retournés.

Nom Type Description
none

string

Aucune propriété supplémentaire.

permissions

string

Incluez les autorisations utilisateur actuelles pour l’objet d’approbation.

steps

string

Incluez les étapes d’approbation associées à l’approbation.

ApprovalExecutionOrder

Ordre dans lequel les approbateurs peuvent être actionnables.

Nom Type Description
anyOrder

string

Indique que les approbateurs peuvent approuver dans n’importe quel ordre.

inSequence

string

Indique que les approbateurs peuvent approuver uniquement dans un ordre séquentiel (ordre dans lequel ils ont été attribués).

ApprovalPermissions

Autorisations utilisateur actuelles pour l’objet d’approbation.

Nom Type Description
none

string

queueBuild

string

reassign

string

resourceAdmin

string

update

string

view

string

ApprovalStatus

Status globale de l’approbation.

Nom Type Description
all

string

approved

string

Indique que l’approbation est Approuvée.

canceled

string

Indique que l’approbation est Annulée.

completed

string

failed

string

pending

string

Indique que l’approbation est en attente.

rejected

string

Indique que l’approbation est Rejetée.

skipped

string

Indique que l’approbation est ignorée.

timedOut

string

Indique que l’approbation est expirée.

undefined

string

uninitiated

string

Indique que l’approbation est non initié. Utilisé dans le cas de dans l’ordre d’exécution où l’approbateur donné n’est pas encore actionnable.

ApprovalStep

Données d’une étape d’approbation unique.

Nom Type Description
actualApprover

IdentityRef

Identité qui a approuvé.

assignedApprover

IdentityRef

Identité qui doit approuver.

comment

string

Commentaire associé à cette étape.

history

ApprovalStepHistory[]

Historique de l’étape d’approbation

initiatedOn

string

Horodatage auquel cette étape a été lancée.

lastModifiedBy

IdentityRef

Identité par laquelle cette étape a été modifiée pour la dernière fois.

lastModifiedOn

string

Horodatage auquel cette étape a été modifiée pour la dernière fois.

order

integer

Ordre dans lequel les approbateurs sont autorisés à approuver.

permissions

ApprovalPermissions

Autorisations utilisateur actuelles pour l’étape.

status

ApprovalStatus

Status actuelles de cette étape.

ApprovalStepHistory

Données pour un historique d’étapes d’approbation unique.

Nom Type Description
assignedTo

IdentityRef

Identité à qui cette approbation a été attribuée

comment

string

Commentaire associé à cet historique des étapes.

createdBy

IdentityRef

Identité par laquelle cet historique des étapes a été créé.

createdOn

string

Horodatage auquel cet historique d’étapes a été créé.

IdentityRef

Nom Type Description
_links

ReferenceLinks

Ce champ contient zéro ou plus de liens intéressants sur le sujet du graphe. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique.

descriptor

string

Le descripteur est le principal moyen de référencer l’objet du graphe pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphe pour les comptes et les organisations.

directoryAlias

string

Déconseillé : peut être récupéré en interrogeant l’utilisateur Graph référencé dans l’entrée « auto » du dictionnaire IdentityRef « _links »

displayName

string

Il s’agit du nom d’affichage non unique du sujet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.

id

string

imageUrl

string

Déconseillé : disponible dans l’entrée « avatar » du dictionnaire IdentityRef « _links »

inactive

boolean

Déconseillé : peut être récupéré en interrogeant l’état d’appartenance Graph référencé dans l’entrée « membershipState » du dictionnaire GraphUser « _links »

isAadIdentity

boolean

Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)

isContainer

boolean

Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsGroupType)

isDeletedInOrigin

boolean

profileUrl

string

Déconseillé : non utilisé dans la plupart des implémentations préexistantes de ToIdentityRef

uniqueName

string

Déconseillé : utilisez Domain+PrincipalName à la place

url

string

Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique.

Classe pour représenter une collection de liens de référence REST.

Nom Type Description
links

object

Vue en lecture seule des liens. Étant donné que les liens de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.