Approvals - Query

Referencia

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Enumerar aprobaciones. Se puede usar para obtener un conjunto de aprobaciones pendientes en una canalización, en un usuario o para un recurso.

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

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?approvalIds={approvalIds}&$expand={$expand}&userIds={userIds}&state={state}&top={top}&api-version=7.1-preview.1

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
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 "7.1-preview.1" para usar esta versión de la API.
$expand	query		ApprovalDetailsExpandParameter	Incluya estos detalles adicionales en los objetos devueltos.
approvalIds	query		string array (uuid)	Lista de identificadores de aprobación que se van a obtener.
state	query		ApprovalStatus	Estado de aprobación. Devuelve aprobaciones de cualquier estado si no se proporciona.
top	query		integer int32	Número máximo de aprobaciones que se van a obtener.
userIds	query		string array (string)	Lista de aprobaciones de identificadores de usuario asignadas. Acepta identificadores de usuario o descriptores de usuario.

Respuestas

Nombre	Tipo	Description
200 OK	Approval[]	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.build	Concede la capacidad de acceder a los artefactos de compilación, incluidos los resultados de la compilación, las definiciones y las solicitudes, y la capacidad de recibir notificaciones sobre eventos de compilación a través de enlaces de servicio.

Ejemplos

Sample Request

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

Sample Response

Status code:: 200

request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context

Response Body

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

Definiciones

Nombre	Description
Approval
ApprovalDetailsExpandParameter	Incluya estos detalles adicionales en los objetos devueltos.
ApprovalExecutionOrder	Orden en el que los aprobadores serán accionables.
ApprovalPermissions	Permisos de usuario actuales para el objeto de aprobación.
ApprovalStatus	Estado general de la aprobación.
ApprovalStep	Datos para un único paso de aprobación.
ApprovalStepHistory	Datos de un único historial de pasos de aprobación.
IdentityRef
ReferenceLinks	Clase que representa una colección de vínculos de referencia de REST.

Approval

Nombre	Tipo	Description
_links	ReferenceLinks	Obtiene los vínculos para acceder al objeto de aprobación.
blockedApprovers	IdentityRef[]	Identidades que no pueden aprobarse.
createdOn	string	Fecha en la que se creó la aprobación.
executionOrder	ApprovalExecutionOrder	Orden en el que los aprobadores serán accionables.
id	string	Identificador único de la aprobación.
instructions	string	Instrucciones para los aprobadores.
lastModifiedOn	string	Fecha en la que se modificó por última vez la aprobación.
minRequiredApprovers	integer	Número mínimo de aprobadores que deben aprobarse para que se considere aprobada toda la aprobación.
permissions	ApprovalPermissions	Permisos de usuario actuales para el objeto de aprobación.
status	ApprovalStatus	Estado general de la aprobación.
steps	ApprovalStep[]	Lista de pasos asociados a la aprobación.

ApprovalDetailsExpandParameter

Incluya estos detalles adicionales en los objetos devueltos.

Nombre	Tipo	Description
none	string	No hay propiedades adicionales.
permissions	string	Incluya los permisos de usuario actuales para el objeto de aprobación.
steps	string	Incluya los pasos de aprobación asociados a la aprobación.

ApprovalExecutionOrder

Orden en el que los aprobadores serán accionables.

Nombre	Tipo	Description
anyOrder	string	Indica que los aprobadores pueden aprobar en cualquier orden.
inSequence	string	Indica que los aprobadores solo pueden aprobar en un orden secuencial (orden en el que se asignaron).

ApprovalPermissions

Permisos de usuario actuales para el objeto de aprobación.

Nombre	Tipo	Description
none	string
queueBuild	string
reassign	string
resourceAdmin	string
update	string
view	string

ApprovalStatus

Estado general de la aprobación.

Nombre	Tipo	Description
all	string
approved	string	Indica que la aprobación es Aprobada.
canceled	string	Indica que se cancela la aprobación.
completed	string
failed	string
pending	string	Indica que la aprobación está pendiente.
rejected	string	Indica que se rechaza la aprobación.
skipped	string	Indica que se omite la aprobación.
timedOut	string	Indica que se agota el tiempo de espera de aprobación.
undefined	string
uninitiated	string	Indica que la aprobación no está inicializada. Se usa en el caso de en orden de ejecución en el que el aprobador dado aún no es accionable.

ApprovalStep

Datos para un único paso de aprobación.

Nombre	Tipo	Description
actualApprover	IdentityRef	Identidad que aprobó.
assignedApprover	IdentityRef	Identidad que debe aprobar.
comment	string	Comentario asociado a este paso.
history	ApprovalStepHistory[]	Historial del paso de aprobación
initiatedOn	string	Marca de tiempo en la que se inició este paso.
lastModifiedBy	IdentityRef	Identidad por la que este paso se modificó por última vez.
lastModifiedOn	string	Marca de tiempo en la que se modificó por última vez este paso.
order	integer	Orden en el que los aprobadores pueden aprobar.
permissions	ApprovalPermissions	Permisos de usuario actuales para el paso.
status	ApprovalStatus	Estado actual de este paso.

ApprovalStepHistory

Datos de un único historial de pasos de aprobación.

Nombre	Tipo	Description
assignedTo	IdentityRef	Identidad a la que se asignó esta aprobación
comment	string	Comentario asociado a este historial de pasos.
createdBy	IdentityRef	Identidad con la que se creó este historial de pasos.
createdOn	string	Marca de tiempo en la que se creó este historial de pasos.

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	En desuso: se puede recuperar consultando el 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" de 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 GraphUser "_links".
isAadIdentity	boolean	En desuso: se puede deducir del tipo de asunto 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.

ReferenceLinks

Clase que representa una colección de vínculos de referencia de 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.

Share via