Approvals - Get

Riferimento

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Ottenere un'approvazione.

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

With optional parameters:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
approvalId	path	True	string uuid	ID dell'approvazione.
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
project	path	True	string	ID progetto o nome del progetto
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '7.1-preview.1' per usare questa versione dell'API.
$expand	query		ApprovalDetailsExpandParameter

Risposte

Nome	Tipo	Descrizione
200 OK	Approval	operazione riuscita

Sicurezza

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

Nome	Descrizione
vso.build	Concede la possibilità di accedere agli artefatti di compilazione, inclusi i risultati di compilazione, le definizioni e le richieste e la possibilità di ricevere notifiche sugli eventi di compilazione tramite hook del servizio.

Esempio

Sample Request

HTTP

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals/{approvalId}?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

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

Definizioni

Nome	Descrizione
Approval
ApprovalDetailsExpandParameter
ApprovalExecutionOrder	Ordine in cui i responsabili approvazione saranno attuabili.
ApprovalPermissions	Autorizzazioni utente correnti per l'oggetto approvazione.
ApprovalStatus	Stato complessivo dell'approvazione.
ApprovalStep	Dati per un singolo passaggio di approvazione.
ApprovalStepHistory	Dati per una singola cronologia dei passaggi di approvazione.
IdentityRef
ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Approval

Nome	Tipo	Descrizione
_links	ReferenceLinks	Ottiene i collegamenti per accedere all'oggetto approvazione.
blockedApprovers	IdentityRef[]	Identità che non sono autorizzate ad approvare.
createdOn	string	Data in cui è stata creata l'approvazione.
executionOrder	ApprovalExecutionOrder	Ordine in cui i responsabili approvazione saranno attuabili.
id	string	Identificatore univoco dell'approvazione.
instructions	string	Istruzioni per i responsabili approvazione.
lastModifiedOn	string	Data dell'ultima modifica dell'approvazione.
minRequiredApprovers	integer	Numero minimo di responsabili approvazione che devono approvare per l'intera approvazione da considerare approvati.
permissions	ApprovalPermissions	Autorizzazioni utente correnti per l'oggetto approvazione.
status	ApprovalStatus	Stato complessivo dell'approvazione.
steps	ApprovalStep[]	Elenco di passaggi associati all'approvazione.

ApprovalDetailsExpandParameter

Nome	Tipo	Descrizione
none	string	Nessuna proprietà aggiuntiva.
permissions	string	Includere le autorizzazioni utente correnti per l'oggetto approvazione.
steps	string	Includere i passaggi di approvazione associati all'approvazione.

ApprovalExecutionOrder

Ordine in cui i responsabili approvazione saranno attuabili.

Nome	Tipo	Descrizione
anyOrder	string	Indica che i responsabili approvazione possono approvare in qualsiasi ordine.
inSequence	string	Indica che i responsabili approvazione possono approvare solo in un ordine sequenziale (ordine in cui sono stati assegnati).

ApprovalPermissions

Autorizzazioni utente correnti per l'oggetto approvazione.

Nome	Tipo	Descrizione
none	string
queueBuild	string
reassign	string
resourceAdmin	string
update	string
view	string

ApprovalStatus

Stato complessivo dell'approvazione.

Nome	Tipo	Descrizione
all	string
approved	string	Indica che l'approvazione è Approvata.
canceled	string	Indica che l'approvazione è Annullata.
completed	string
failed	string
pending	string	Indica che l'approvazione è in sospeso.
rejected	string	Indica che l'approvazione è Rifiutata.
skipped	string	Indica che l'approvazione è Ignorata.
timedOut	string	Indica che l'approvazione è timeout.
undefined	string
uninitiated	string	Indica che l'approvazione è Non inizializzata. Usato nel caso di in ordine di sequenza di esecuzione in cui il responsabile approvazione specificato non è ancora utilizzabile.

ApprovalStep

Dati per un singolo passaggio di approvazione.

Nome	Tipo	Descrizione
actualApprover	IdentityRef	Identità approvata.
assignedApprover	IdentityRef	Identità che deve approvare.
comment	string	Commento associato a questo passaggio.
history	ApprovalStepHistory[]	Cronologia del passaggio di approvazione
initiatedOn	string	Timestamp in corrispondenza del quale è stato avviato questo passaggio.
lastModifiedBy	IdentityRef	Identità in base alla quale questo passaggio è stato modificato per l'ultima volta.
lastModifiedOn	string	Timestamp in corrispondenza del quale questo passaggio è stato modificato per l'ultima volta.
order	integer	Ordine in cui i responsabili approvazione sono autorizzati ad approvare.
permissions	ApprovalPermissions	Autorizzazioni utente correnti per il passaggio.
status	ApprovalStatus	Stato corrente di questo passaggio.

ApprovalStepHistory

Dati per una singola cronologia dei passaggi di approvazione.

Nome	Tipo	Descrizione
assignedTo	IdentityRef	Identità a cui è stata assegnata l'approvazione
comment	string	Commento associato alla cronologia dei passaggi.
createdBy	IdentityRef	Identità in base alla quale è stata creata la cronologia dei passaggi.
createdOn	string	Timestamp in corrispondenza del quale è stata creata la cronologia dei passaggi.

IdentityRef

Nome	Tipo	Descrizione
_links	ReferenceLinks	Questo campo contiene zero o più collegamenti interessanti sull'oggetto del grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate su questo oggetto grafico.
descriptor	string	Il descrittore è il modo principale per fare riferimento all'oggetto del grafo mentre il sistema è in esecuzione. Questo campo identificherà in modo univoco lo stesso oggetto grafico in account e organizzazioni.
directoryAlias	string	Deprecato: può essere recuperato eseguendo una query sull'utente graph a cui si fa riferimento nella voce "self" del dizionario "_links" IdentityRef
displayName	string	Si tratta del nome visualizzato non univoco dell'oggetto del grafico. Per modificare questo campo, è necessario modificarne il valore nel provider di origine.
id	string
imageUrl	string	Deprecato : disponibile nella voce "avatar" del dizionario IdentityRef "_links"
inactive	boolean	Deprecato: può essere recuperato eseguendo una query sullo stato di appartenenza graph a cui si fa riferimento nella voce "membershipState" del dizionario GraphUser "_links"
isAadIdentity	boolean	Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Deprecato: non in uso nella maggior parte delle implementazioni preesistenti di ToIdentityRef
uniqueName	string	Deprecato: usare invece Domain+PrincipalName
url	string	Questo URL è la route completa alla risorsa di origine di questo oggetto grafico.

ReferenceLinks

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura.

Condividi tramite