Approvals - List

Référence

Service:: Release

Version d'API:: 7.1

Obtenir la liste des approbations

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

Avec des paramètres facultatifs:

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

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.
assignedToFilter	query		string	Approbations attribuées à cet utilisateur.
continuationToken	query		integer (int32)	Obtient les approbations après le jeton de continuation fourni.
includeMyGroupApprovals	query		boolean	« true » pour inclure mes approbations de groupe. La valeur par défaut est « false ».
queryOrder	query		ReleaseQueryOrder	Obtient les résultats dans l’ordre défini des approbations créées. La valeur par défaut est « décroissante ».
releaseIdsFilter	query		string (array (int32))	Approbations pour les ID de mise en production mentionnés dans le filtre. Plusieurs versions peuvent être mentionnées en les séparant par « », par exemple releaseIdsFilter=1,2,3,4.
statusFilter	query		ApprovalStatus	Approbations avec cet état. La valeur par défaut est « en attente ».
top	query		integer (int32)	Nombre d’approbations à obtenir. La valeur par défaut est 50.
typeFilter	query		ApprovalType	Approbation avec ce type.

Réponses

Nom	Type	Description
200 OK	ReleaseApproval[]	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.release	Accorde la possibilité de lire les artefacts de mise en production, notamment les dossiers, les versions, les définitions de mise en production et l’environnement de mise en production.

Exemples

Pending for a specific release

Pending for a specific user

Pending for all users

Pending for a specific release

Exemple de requête

HTTP

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

Exemple de réponse

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

Exemple de requête

HTTP

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

Exemple de réponse

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

Exemple de requête

HTTP

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

Exemple de réponse

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

Définitions

Nom	Description
ApprovalStatus	Obtient ou définit l’état de l’approbation.
ApprovalType	Obtient ou définit le type d’approbation.
IdentityRef
ProjectReference
ReferenceLinks	Classe à représenter une collection de liens de référence REST.
ReleaseApproval
ReleaseApprovalHistory
ReleaseDefinitionShallowReference
ReleaseEnvironmentShallowReference
ReleaseQueryOrder	Obtient les résultats dans l’ordre défini des approbations créées. La valeur par défaut est « décroissante ».
ReleaseShallowReference

ApprovalStatus

Énumération

Obtient ou définit l’état de l’approbation.

Valeur	Description
approved	Indique que l’approbation est approuvée.
canceled	Indique que l’approbation est annulée.
pending	Indique que l’approbation est en attente.
reassigned	Indique que l’approbation est réaffectée.
rejected	Indique que l’approbation est rejetée.
skipped	Indique que l’approbation est ignorée.
undefined	Indique que l’approbation n’a pas l’état défini.

ApprovalType

Énumération

Obtient ou définit le type d’approbation.

Valeur	Description
all	Indique toutes les approbations.
postDeploy	Indique les approbations exécutées après le déploiement.
preDeploy	Indique les approbations exécutées avant le déploiement.
undefined	Indique que le type d’approbation n’est pas défini.

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.

ProjectReference

Object

Nom	Type	Description
id	string (uuid)	Obtient l’identificateur unique de ce champ.
name	string	Obtient le nom du projet.

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.

ReleaseApproval

Object

Nom	Type	Description
approvalType	ApprovalType	Obtient ou définit le type d’approbation.
approvedBy	IdentityRef	Obtient l’identité approuvée.
approver	IdentityRef	Obtient ou définit l’identité qui doit approuver.
attempt	integer (int32)	Obtient ou définit une tentative qui spécifie la tentative de déploiement qui lui appartient.
comments	string	Obtient ou définit des commentaires pour approbation.
createdOn	string (date-time)	Obtient la date à laquelle elle a été créée.
history	ReleaseApprovalHistory[]	Obtient l’historique qui spécifie toutes les approbations associées à cette approbation.
id	integer (int32)	Obtient l’identificateur unique de ce champ.
isAutomated	boolean	Obtient ou définit en tant qu’approbation automatisée ou non.
modifiedOn	string (date-time)	Obtient la date à laquelle elle a été modifiée.
rank	integer (int32)	Obtient ou définit le classement qui spécifie l’ordre de l’approbation. Par exemple, le même rang désigne l’approbation parallèle.
release	ReleaseShallowReference	Obtient releaseReference qui spécifie la référence de la version à laquelle cette approbation est associée.
releaseDefinition	ReleaseDefinitionShallowReference	Obtient releaseDefinitionReference qui spécifie la référence de la définition de mise en production à laquelle cette approbation est associée.
releaseEnvironment	ReleaseEnvironmentShallowReference	Obtient releaseEnvironmentReference qui spécifie la référence de l’environnement de mise en production auquel cette approbation est associée.
revision	integer (int32)	Obtient le numéro de révision.
status	ApprovalStatus	Obtient ou définit l’état de l’approbation.
url	string	Obtient l’URL pour accéder à l’approbation.

ReleaseApprovalHistory

Object

Nom	Type	Description
approver	IdentityRef	Identité de l’approbateur.
changedBy	IdentityRef	Identité de l’objet qui a modifié l’approbation.
comments	string	Commentaires de l’historique d’approbation.
createdOn	string (date-time)	Heure à laquelle cette approbation a été créée.
modifiedOn	string (date-time)	Heure à laquelle cette approbation a été modifiée.
revision	integer (int32)	Révision de l’historique d’approbation.

ReleaseDefinitionShallowReference

Object

Nom	Type	Description
_links	ReferenceLinks	Obtient les liens vers les ressources, LES API et les vues associées pour la définition de mise en production.
id	integer (int32)	Obtient l’identificateur unique de la définition de mise en production.
name	string	Obtient ou définit le nom de la définition de mise en production.
path	string	Obtient ou définit le chemin d’accès de la définition de mise en production.
projectReference	ProjectReference	Obtient ou définit la référence du projet.
url	string	Obtient l’URL de l’API REST pour accéder à la définition de mise en production.

ReleaseEnvironmentShallowReference

Object

Nom	Type	Description
_links	ReferenceLinks	Obtient les liens vers les ressources, LES API et les vues associées pour l’environnement de mise en production.
id	integer (int32)	Obtient l’identificateur unique de l’environnement de mise en production.
name	string	Obtient ou définit le nom de l’environnement de mise en production.
url	string	Obtient l’URL de l’API REST pour accéder à l’environnement de mise en production.

ReleaseQueryOrder

Énumération

Obtient les résultats dans l’ordre défini des approbations créées. La valeur par défaut est « décroissante ».

Valeur	Description
ascending	Retourne les résultats dans l’ordre croissant.
descending	Retourne les résultats dans l’ordre décroissant.

ReleaseShallowReference

Object

Nom	Type	Description
_links	ReferenceLinks	Obtient les liens vers les ressources, LES API et les vues associées pour la version.
id	integer (int32)	Obtient l’identificateur unique de mise en production.
name	string	Obtient ou définit le nom de la version.
url	string	Obtient l’URL de l’API REST pour accéder à la version.