Approvals - Update

Référence

Service:: Release

API Version:: 5.0

Mettre à jour status d’une approbation

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
approvalId	path	True	integer int32	ID de l’approbation.
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 « 5.0 » pour utiliser cette version de l’API.

Corps de la demande

Nom	Type	Description
approvalType	ApprovalType	Obtient ou définit le type d’approbation.
approvedBy	IdentityRef	Obtient l’identité qui a approuvé.
approver	IdentityRef	Obtient ou définit l’identité qui doit approuver.
attempt	integer	Obtient ou définit la tentative qui spécifie à quelle tentative de déploiement elle appartient.
comments	string	Obtient ou définit des commentaires pour approbation.
createdOn	string	Obtient la date à laquelle il a été créé.
history	ReleaseApprovalHistory[]	Obtient l’historique qui spécifie toutes les approbations associées à cette approbation.
id	integer	Obtient l’identificateur unique de ce champ.
isAutomated	boolean	Obtient ou définit à mesure que l’approbation est automatisée ou non.
isNotificationOn	boolean
modifiedOn	string	Obtient la date à laquelle il a été modifié.
rank	integer	Obtient ou définit le rang qui spécifie l’ordre de l’approbation. Par exemple, le même rang indique une 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	Obtient le numéro de révision.
status	ApprovalStatus	Obtient ou définit le status de l’approbation.
trialNumber	integer
url	string	Obtient l’URL pour accéder à l’approbation.

Réponses

Nom	Type	Description
200 OK	ReleaseApproval	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.release_manage	Accorde la possibilité de lire, de mettre à jour et de supprimer des artefacts de mise en production, y compris les versions, les définitions de mise en production et l’envrion de mise en production, ainsi que la possibilité de mettre en file d’attente et d’approuver une nouvelle version.

Exemples

Approve a release

Sample Request

HTTP

PATCH https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/approvals/{approvalId}?api-version=5.0

{
  "status": "approved",
  "comments": "Good to go!"
}

Sample Response

Status code:: 200

{
  "id": 20,
  "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"
  },
  "approvedBy": {
    "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-31T18:07:40.45Z",
  "modifiedOn": "2017-05-31T18:08:09.577Z",
  "status": "approved",
  "comments": "Good to go!",
  "isAutomated": false,
  "isNotificationOn": true,
  "trialNumber": 1,
  "attempt": 1,
  "rank": 1,
  "history": [],
  "release": {
    "id": 3,
    "name": "Release-3",
    "url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/releases/3",
    "_links": {}
  },
  "releaseDefinition": {
    "id": 1,
    "name": "MyShuttle.CD",
    "url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
    "_links": {}
  },
  "releaseEnvironment": {
    "id": 9,
    "name": "Dev",
    "_links": {}
  },
  "url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/approvals/20"
}

Définitions

Nom	Description
ApprovalStatus	Obtient ou définit le status de l’approbation.
ApprovalType	Obtient ou définit le type d’approbation.
IdentityRef
ProjectReference
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
ReleaseApproval
ReleaseApprovalHistory
ReleaseDefinitionShallowReference
ReleaseEnvironmentShallowReference
ReleaseShallowReference

ApprovalStatus

Obtient ou définit le status de l’approbation.

Nom	Type	Description
approved	string
canceled	string
pending	string
reassigned	string
rejected	string
skipped	string
undefined	string

ApprovalType

Obtient ou définit le type d’approbation.

Nom	Type	Description
all	string
postDeploy	string
preDeploy	string
undefined	string

IdentityRef

Nom	Type	Description
_links	ReferenceLinks	Ce champ contient zéro ou plus de liens intéressants sur l’objet du graphique. 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 dans les comptes et les organisations.
directoryAlias	string
displayName	string	Il s’agit du nom d’affichage non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique.

ProjectReference

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

ReferenceLinks

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 référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

ReleaseApproval

Nom	Type	Description
approvalType	ApprovalType	Obtient ou définit le type d’approbation.
approvedBy	IdentityRef	Obtient l’identité qui a approuvé.
approver	IdentityRef	Obtient ou définit l’identité qui doit approuver.
attempt	integer	Obtient ou définit la tentative qui spécifie à quelle tentative de déploiement elle appartient.
comments	string	Obtient ou définit des commentaires pour approbation.
createdOn	string	Obtient la date à laquelle il a été créé.
history	ReleaseApprovalHistory[]	Obtient l’historique qui spécifie toutes les approbations associées à cette approbation.
id	integer	Obtient l’identificateur unique de ce champ.
isAutomated	boolean	Obtient ou définit à mesure que l’approbation est automatisée ou non.
isNotificationOn	boolean
modifiedOn	string	Obtient la date à laquelle il a été modifié.
rank	integer	Obtient ou définit le rang qui spécifie l’ordre de l’approbation. Par exemple, le même rang indique une 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	Obtient le numéro de révision.
status	ApprovalStatus	Obtient ou définit le status de l’approbation.
trialNumber	integer
url	string	Obtient l’URL pour accéder à l’approbation.

ReleaseApprovalHistory

Nom	Type	Description
approver	IdentityRef
changedBy	IdentityRef
comments	string
createdOn	string
modifiedOn	string
revision	integer

ReleaseDefinitionShallowReference

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	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 une référence de projet.
url	string	Obtient l’URL de l’API REST pour accéder à la définition de mise en production.

ReleaseEnvironmentShallowReference

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

ReleaseShallowReference

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

Partager via