Approvals - Query

Référence

Service:: Approvals And Checks

Version d'API:: 7.1

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

Avec des paramètres facultatifs:

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?approvalIds={approvalIds}&$expand={$expand}&userIds={userIds}&state={state}&top={top}&api-version=7.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 » 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	État d’approbation. Retourne les approbations d’un état 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 d’utilisateur affectées. Accepte les ID d’utilisateur ou les descripteurs utilisateur.

Réponses

Nom	Type	Description
200 OK	Approval[]	opération réussie

Sécurité

oauth2

Type: oauth2
Flux: accessCode
URL d’autorisation: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton: 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

Étendues

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

Exemples

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
        }
      }
    }
  ]
}

Définitions

Nom	Description
Approval
ApprovalDetailsExpandParameter	Incluez ces détails supplémentaires dans les objets retournés.
ApprovalExecutionOrder	Ordre dans lequel les approbateurs seront actionnables.
ApprovalPermissions	Autorisations utilisateur actuelles pour l’objet d’approbation.
ApprovalStatus	État global de l’approbation.
ApprovalStep	Données pour une seule étape d’approbation.
ApprovalStepHistory	Données pour un historique d’étape d’approbation unique.
IdentityRef
ReferenceLinks	Classe à représenter une collection de liens de référence REST.

Approval

Object

Nom	Type	Description
_links	ReferenceLinks	Obtient les liens pour accéder à l’objet d’approbation.
blockedApprovers	IdentityRef[]	Identités qui ne sont pas autorisées à approuver.
createdOn	string (date-time)	Date à laquelle l’approbation a été créée.
executionOrder	ApprovalExecutionOrder	Ordre dans lequel les approbateurs seront actionnables.
id	string (uuid)	Identificateur unique de l’approbation.
instructions	string	Instructions pour les approbateurs.
lastModifiedOn	string (date-time)	Date de dernière modification de l’approbation.
minRequiredApprovers	integer (int32)	Nombre minimal d’approbateurs qui doivent approuver l’ensemble de l’approbation pour être considérés comme approuvés.
permissions	ApprovalPermissions	Autorisations utilisateur actuelles pour l’objet d’approbation.
status	ApprovalStatus	État global de l’approbation.
steps	ApprovalStep[]	Liste des étapes associées à l’approbation.

ApprovalDetailsExpandParameter

Énumération

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

Valeur	Description
none	Aucune propriété supplémentaire.
permissions	Incluez les autorisations utilisateur actuelles pour l’objet d’approbation.
steps	Incluez les étapes d’approbation associées à l’approbation.

ApprovalExecutionOrder

Énumération

Ordre dans lequel les approbateurs seront actionnables.

Valeur	Description
anyOrder	Indique que les approbateurs peuvent approuver dans n’importe quel ordre.
inSequence	Indique que les approbateurs ne peuvent approuver qu’dans un ordre séquentiel (Ordre dans lequel ils ont été attribués).

ApprovalPermissions

Énumération

Autorisations utilisateur actuelles pour l’objet d’approbation.

Valeur	Description
none
queueBuild
reassign
resourceAdmin
update
view

ApprovalStatus

Énumération

État global de l’approbation.

Valeur	Description
all
approved	Indique que l’approbation est approuvée.
canceled	Indique que l’approbation est annulée.
completed
failed
pending	Indique que l’approbation est en attente.
rejected	Indique que l’approbation est rejetée.
skipped	Indique que l’approbation est ignorée.
timedOut	Indique que l’approbation est expirée.
undefined
uninitiated	Indique que l’approbation n’est pas approuvée. Utilisé dans le cas d’une séquence d’exécution où l’approbateur donné n’est pas encore actionnable.

ApprovalStep

Object

Données pour une seule étape d’approbation.

Nom	Type	Description
actualApprover	IdentityRef	Identité approuvée.
assignedApprover	IdentityRef	Identité qui doit approuver.
comment	string	Commentaire associé à cette étape.
history	ApprovalStepHistory[]	Historique de l’étape d’approbation
initiatedOn	string (date-time)	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 (date-time)	Horodatage auquel cette étape a été modifiée pour la dernière fois.
order	integer (int32)	Ordre dans lequel les approbateurs sont autorisés à approuver.
permissions	ApprovalPermissions	Autorisations utilisateur actuelles pour l’étape.
status	ApprovalStatus	État actuel de cette étape.

ApprovalStepHistory

Object

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

Nom	Type	Description
assignedTo	IdentityRef	Identité qui a été affectée à cette approbation
comment	string	Commentaire associé à cet historique d’étapes.
createdBy	IdentityRef	Identité par laquelle l’historique des étapes a été créé.
createdOn	string (date-time)	Horodatage auquel l’historique des étapes a été créé.

IdentityRef

Object

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 graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique sur 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 complet non unique de l’objet 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é : utiliser Domain+PrincipalName à la place
url	string	Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphe.

ReferenceLinks

Object

Classe à 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.

Partager via

Approvals - Query

Paramètres URI

Réponses

Sécurité

oauth2

Étendues

Exemples

Exemple de requête

Exemple de réponse

Définitions

Approval

ApprovalDetailsExpandParameter

ApprovalExecutionOrder

ApprovalPermissions

ApprovalStatus

ApprovalStep

ApprovalStepHistory

IdentityRef

ReferenceLinks