Approvals - List

Referencia

Servicio:: Release

Versión de la API:: 7.1

Obtener una lista de aprobaciones

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	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 "7.1" para usar esta versión de la API.
assignedToFilter	query		string	Aprobaciones asignadas a este usuario.
continuationToken	query		integer (int32)	Obtiene las aprobaciones después del token de continuación proporcionado.
includeMyGroupApprovals	query		boolean	"true" para incluir mis aprobaciones de grupo. El valor predeterminado es "false".
queryOrder	query		ReleaseQueryOrder	Obtiene los resultados en el orden definido de aprobaciones creadas. El valor predeterminado es "descendente".
releaseIdsFilter	query		string (array (int32))	Aprobaciones para identificadores de versión mencionados en el filtro. Se pueden mencionar varias versiones separandolas con "", por ejemplo, releaseIdsFilter=1,2,3,4.
statusFilter	query		ApprovalStatus	Aprobaciones con este estado. El valor predeterminado es "pendiente".
top	query		integer (int32)	Número de aprobaciones que se van a obtener. El valor predeterminado es 50.
typeFilter	query		ApprovalType	Aprobación con este tipo.

Respuestas

Nombre	Tipo	Description
200 OK	ReleaseApproval[]	operación correcta

Seguridad

oauth2

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del token: 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

Ámbitos

Nombre	Description
vso.release	Concede la capacidad de leer artefactos de versión, incluidas carpetas, versiones, definiciones de versión y entorno de versión.

Ejemplos

Pending for a specific release

Pending for a specific user

Pending for all users

Pending for a specific release

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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"
    }
  ]
}

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 representa una colección de vínculos de referencia rest.
ReleaseApproval
ReleaseApprovalHistory
ReleaseDefinitionShallowReference
ReleaseEnvironmentShallowReference
ReleaseQueryOrder	Obtiene los resultados en el orden definido de aprobaciones creadas. El valor predeterminado es "descendente".
ReleaseShallowReference

ApprovalStatus

Enumeración

Obtiene o establece el estado de la aprobación.

Valor	Description
approved	Indica que se aprueba la aprobación.
canceled	Indica que se cancela la aprobación.
pending	Indica que la aprobación está pendiente.
reassigned	Indica que la aprobación se reasigna.
rejected	Indica que se rechaza la aprobación.
skipped	Indica que se omite la aprobación.
undefined	Indica que la aprobación no tiene establecido el estado.

ApprovalType

Enumeración

Obtiene o establece el tipo de aprobación.

Valor	Description
all	Indica todas las aprobaciones.
postDeploy	Indica las aprobaciones que se ejecutaron después de la implementación.
preDeploy	Indica las aprobaciones que se ejecutaron antes de la implementación.
undefined	Indica que el tipo de aprobación no se establece.

IdentityRef

Object

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	En desuso: se puede recuperar consultando al usuario de Graph al que se hace referencia en la entrada "self" del diccionario identityRef "_links".
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	En desuso: disponible en la entrada "avatar" del diccionario "_links" identityRef
inactive	boolean	En desuso: se puede recuperar consultando el estado de pertenencia de Graph al que se hace referencia en la entrada "membershipState" del diccionario "_links" de GraphUser.
isAadIdentity	boolean	En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	En desuso: no en uso en la mayoría de las implementaciones preexistentes de ToIdentityRef
uniqueName	string	En desuso: use Domain+PrincipalName en su lugar.
url	string	Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo.

ProjectReference

Object

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

ReferenceLinks

Object

Clase que representa una colección de vínculos de referencia rest.

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

ReleaseApproval

Object

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 (int32)	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 (date-time)	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 (int32)	Obtiene el identificador único de este campo.
isAutomated	boolean	Obtiene o establece como aprobación automatizada o no.
modifiedOn	string (date-time)	Obtiene la fecha en la que se modificó.
rank	integer (int32)	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 (int32)	Obtiene el número de revisión.
status	ApprovalStatus	Obtiene o establece el estado de la aprobación.
url	string	Obtiene la dirección URL para acceder a la aprobación.

ReleaseApprovalHistory

Object

Nombre	Tipo	Description
approver	IdentityRef	Identidad del aprobador.
changedBy	IdentityRef	Identidad del objeto que cambió la aprobación.
comments	string	Comentarios del historial de aprobación.
createdOn	string (date-time)	Hora a la que se creó esta aprobación.
modifiedOn	string (date-time)	Hora a la que se modificó esta aprobación.
revision	integer (int32)	Revisión del historial de aprobación.

ReleaseDefinitionShallowReference

Object

Nombre	Tipo	Description
_links	ReferenceLinks	Obtiene los vínculos a recursos, API y vistas relacionados para la definición de versión.
id	integer (int32)	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

Object

Nombre	Tipo	Description
_links	ReferenceLinks	Obtiene los vínculos a recursos, API y vistas relacionados para el entorno de versión.
id	integer (int32)	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.

ReleaseQueryOrder

Enumeración

Obtiene los resultados en el orden definido de aprobaciones creadas. El valor predeterminado es "descendente".

Valor	Description
ascending	Devuelve los resultados en orden ascendente.
descending	Devuelve los resultados en orden descendente.

ReleaseShallowReference

Object

Nombre	Tipo	Description
_links	ReferenceLinks	Obtiene los vínculos a recursos, API y vistas relacionados para la versión.
id	integer (int32)	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.

Compartir a través de

Approvals - List

Parámetros de identificador URI

Respuestas

Seguridad

oauth2

Ámbitos

Ejemplos

Pending for a specific release

Solicitud de ejemplo

Respuesta de muestra

Pending for a specific user

Solicitud de ejemplo

Respuesta de muestra

Pending for all users

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ApprovalStatus

ApprovalType

IdentityRef

ProjectReference

ReferenceLinks

ReleaseApproval

ReleaseApprovalHistory

ReleaseDefinitionShallowReference

ReleaseEnvironmentShallowReference

ReleaseQueryOrder

ReleaseShallowReference