Approvals - Update

Service:

Release

API Version:

5.0

Estado de actualización de una aprobación

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
approvalId	path	True	integer int32	Identificador de la aprobación.
organization	path	True	string	El nombre de la organización de Azure DevOps.
project	path	True	string	Id. de proyecto o nombre del proyecto
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "5.0" para usar esta versión de la API.

Cuerpo de la solicitud

Nombre	Tipo	Description
approvalType	ApprovalType	Obtiene o establece el tipo de aprobación.
approvedBy	IdentityRef	Obtiene la identidad que ha aprobado.
approver	IdentityRef	Obtiene o establece la identidad que debe aprobar.
attempt	integer	Obtiene o establece el intento que especifica el intento de implementación al que pertenece.
comments	string	Obtiene o establece comentarios para su aprobación.
createdOn	string	Obtiene la fecha en la que se creó.
history	ReleaseApprovalHistory[]	Obtiene el historial que especifica todas las aprobaciones asociadas a esta aprobación.
id	integer	Obtiene el identificador único de este campo.
isAutomated	boolean	Obtiene o establece como aprobación automatizada o no.
isNotificationOn	boolean
modifiedOn	string	Obtiene la fecha en la que se modificó.
rank	integer	Obtiene o establece la clasificación que especifica el orden de la aprobación. Por ejemplo, la misma clasificación denota la aprobación en paralelo.
release	ReleaseShallowReference	Obtiene releaseReference que especifica la referencia de la versión a la que está asociada esta aprobación.
releaseDefinition	ReleaseDefinitionShallowReference	Obtiene releaseDefinitionReference que especifica la referencia de la definición de versión a la que está asociada esta aprobación.
releaseEnvironment	ReleaseEnvironmentShallowReference	Obtiene releaseEnvironmentReference, que especifica la referencia del entorno de versión al que está asociada esta aprobación.
revision	integer	Obtiene el número de revisión.
status	ApprovalStatus	Obtiene o establece el estado de la aprobación.
trialNumber	integer
url	string	Obtiene la dirección URL para acceder a la aprobación.

Respuestas

Nombre	Tipo	Description
200 OK	ReleaseApproval	operación correcta

Seguridad

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

Nombre	Description
vso.release_manage	Concede la capacidad de leer, actualizar y eliminar artefactos de versión, incluidas las versiones, las definiciones de versión y la envrionment de versiones, y la capacidad de poner en cola y aprobar una nueva versión.

Ejemplos

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

Definiciones

Nombre	Description
ApprovalStatus	Obtiene o establece el estado de la aprobación.
ApprovalType	Obtiene o establece el tipo de aprobación.
IdentityRef
ProjectReference
ReferenceLinks	Clase que se va a representar una colección de vínculos de referencia de REST.
ReleaseApproval
ReleaseApprovalHistory
ReleaseDefinitionShallowReference
ReleaseEnvironmentShallowReference
ReleaseShallowReference

ApprovalStatus

Obtiene o establece el estado de la aprobación.

Nombre	Tipo	Description
approved	string
canceled	string
pending	string
reassigned	string
rejected	string
skipped	string
undefined	string

ApprovalType

Obtiene o establece el tipo de aprobación.

Nombre	Tipo	Description
all	string
postDeploy	string
preDeploy	string
undefined	string

IdentityRef

Nombre	Tipo	Description
_links	ReferenceLinks	Este campo contiene cero o más vínculos interesantes sobre el tema del grafo. Estos vínculos se pueden invocar para obtener relaciones adicionales o información más detallada sobre este tema del grafo.
descriptor	string	El descriptor es la forma principal de hacer referencia al asunto del grafo mientras se ejecuta el sistema. Este campo identificará de forma única el mismo asunto del grafo en cuentas y organizaciones.
directoryAlias	string
displayName	string	Este es el nombre para mostrar no único del asunto del grafo. Para cambiar este campo, debe modificar su valor en el proveedor de origen.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo.

ProjectReference

Nombre	Tipo	Description
id	string	Obtiene el identificador único de este campo.
name	string	Obtiene el nombre del proyecto.

ReferenceLinks

Clase que se va a representar una colección de vínculos de referencia de REST.

Nombre	Tipo	Description
links	object	Vista de lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura.

ReleaseApproval

Nombre	Tipo	Description
approvalType	ApprovalType	Obtiene o establece el tipo de aprobación.
approvedBy	IdentityRef	Obtiene la identidad que ha aprobado.
approver	IdentityRef	Obtiene o establece la identidad que debe aprobar.
attempt	integer	Obtiene o establece el intento que especifica el intento de implementación al que pertenece.
comments	string	Obtiene o establece comentarios para su aprobación.
createdOn	string	Obtiene la fecha en la que se creó.
history	ReleaseApprovalHistory[]	Obtiene el historial que especifica todas las aprobaciones asociadas a esta aprobación.
id	integer	Obtiene el identificador único de este campo.
isAutomated	boolean	Obtiene o establece como aprobación automatizada o no.
isNotificationOn	boolean
modifiedOn	string	Obtiene la fecha en la que se modificó.
rank	integer	Obtiene o establece la clasificación que especifica el orden de la aprobación. Por ejemplo, la misma clasificación denota la aprobación en paralelo.
release	ReleaseShallowReference	Obtiene releaseReference que especifica la referencia de la versión a la que está asociada esta aprobación.
releaseDefinition	ReleaseDefinitionShallowReference	Obtiene releaseDefinitionReference que especifica la referencia de la definición de versión a la que está asociada esta aprobación.
releaseEnvironment	ReleaseEnvironmentShallowReference	Obtiene releaseEnvironmentReference, que especifica la referencia del entorno de versión al que está asociada esta aprobación.
revision	integer	Obtiene el número de revisión.
status	ApprovalStatus	Obtiene o establece el estado de la aprobación.
trialNumber	integer
url	string	Obtiene la dirección URL para acceder a la aprobación.

ReleaseApprovalHistory

Nombre	Tipo	Description
approver	IdentityRef
changedBy	IdentityRef
comments	string
createdOn	string
modifiedOn	string
revision	integer

ReleaseDefinitionShallowReference

Nombre	Tipo	Description
_links	ReferenceLinks	Obtiene los vínculos a recursos, API y vistas relacionados para la definición de versión.
id	integer	Obtiene el identificador único de la definición de versión.
name	string	Obtiene o establece el nombre de la definición de versión.
path	string	Obtiene o establece la ruta de acceso de la definición de versión.
projectReference	ProjectReference	Obtiene o establece la referencia del proyecto.
url	string	Obtiene la dirección URL de la API REST para acceder a la definición de versión.

ReleaseEnvironmentShallowReference

Nombre	Tipo	Description
_links	ReferenceLinks	Obtiene los vínculos a recursos, API y vistas relacionados para el entorno de versión.
id	integer	Obtiene el identificador único del entorno de versión.
name	string	Obtiene o establece el nombre del entorno de versión.
url	string	Obtiene la dirección URL de la API rest para acceder al entorno de versión.

ReleaseShallowReference

Nombre	Tipo	Description
_links	ReferenceLinks	Obtiene los vínculos a recursos, API y vistas relacionados para la versión.
id	integer	Obtiene el identificador único de la versión.
name	string	Obtiene o establece el nombre de la versión.
url	string	Obtiene la dirección URL de la API rest para acceder a la versión.