Approvals - Update

Riferimento

Servizio:: Release

Versione API:: 7.1

Aggiornare lo stato di un'approvazione

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
approvalId	path	True	integer (int32)	ID dell'approvazione.
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
project	path	True	string	ID progetto o nome progetto
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '7.1' per usare questa versione dell'API.

Corpo della richiesta

Nome	Tipo	Descrizione
approvalType	ApprovalType	Ottiene o imposta il tipo di approvazione.
approvedBy	IdentityRef	Ottiene l'identità approvata.
approver	IdentityRef	Ottiene o imposta l'identità che deve approvare.
attempt	integer (int32)	Ottiene o imposta un tentativo che specifica come quale tentativo di distribuzione appartiene.
comments	string	Ottiene o imposta i commenti per l'approvazione.
createdOn	string (date-time)	Ottiene la data in cui è stata creata.
history	ReleaseApprovalHistory[]	Ottiene la cronologia che specifica tutte le approvazioni associate all'approvazione.
id	integer (int32)	Ottiene l'identificatore univoco di questo campo.
isAutomated	boolean	Ottiene o imposta quando l'approvazione è automatizzata o meno.
modifiedOn	string (date-time)	Ottiene la data in cui è stata modificata.
rank	integer (int32)	Ottiene o imposta la classificazione che specifica l'ordine dell'approvazione. Ad esempio, lo stesso rango indica l'approvazione parallela.
release	ReleaseShallowReference	Ottiene releaseReference che specifica il riferimento della versione a cui è associata l'approvazione.
releaseDefinition	ReleaseDefinitionShallowReference	Ottiene releaseDefinitionReference che specifica il riferimento della definizione di versione a cui è associata l'approvazione.
releaseEnvironment	ReleaseEnvironmentShallowReference	Ottiene releaseEnvironmentReference che specifica il riferimento dell'ambiente di rilascio a cui è associata questa approvazione.
revision	integer (int32)	Ottiene il numero di revisione.
status	ApprovalStatus	Ottiene o imposta lo stato dell'approvazione.
url	string	Ottiene l'URL per accedere all'approvazione.

Risposte

Nome	Tipo	Descrizione
200 OK	ReleaseApproval	operazione riuscita

Sicurezza

oauth2

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL 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

Ambiti

Nome	Descrizione
vso.release_manage	Concede la possibilità di leggere, aggiornare ed eliminare artefatti di versione, incluse cartelle, versioni, definizioni di versione e ambiente di rilascio e la possibilità di accodare e approvare una nuova versione.

Esempio

Approve a release

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:: 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://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/releases/3",
    "_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": 9,
    "name": "Dev",
    "_links": {}
  },
  "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/approvals/20"
}

Definizioni

Nome	Descrizione
ApprovalStatus	Ottiene o imposta lo stato dell'approvazione.
ApprovalType	Ottiene o imposta il tipo di approvazione.
IdentityRef
ProjectReference
ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
ReleaseApproval
ReleaseApprovalHistory
ReleaseDefinitionShallowReference
ReleaseEnvironmentShallowReference
ReleaseShallowReference

ApprovalStatus

Enumerazione

Ottiene o imposta lo stato dell'approvazione.

Valore	Descrizione
approved	Indica che l'approvazione è approvata.
canceled	Indica che l'approvazione è stata annullata.
pending	Indica che l'approvazione è in sospeso.
reassigned	Indica che l'approvazione è riassegnata.
rejected	Indica che l'approvazione è stata rifiutata.
skipped	Indica che l'approvazione viene ignorata.
undefined	Indica che l'approvazione non ha il set di stato.

ApprovalType

Enumerazione

Ottiene o imposta il tipo di approvazione.

Valore	Descrizione
all	Indica tutte le approvazioni.
postDeploy	Indica le approvazioni eseguite dopo la distribuzione.
preDeploy	Indica le approvazioni eseguite prima della distribuzione.
undefined	Indica che il tipo di approvazione non è impostato.

IdentityRef

Object

Nome	Tipo	Descrizione
_links	ReferenceLinks	Questo campo contiene zero o più collegamenti interessanti sull'oggetto grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate sull'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 soggetto del 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 IdentityRef "_links"
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 "_links" GraphUser
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.

ProjectReference

Object

Nome	Tipo	Descrizione
id	string (uuid)	Ottiene l'identificatore univoco di questo campo.
name	string	Ottiene il nome del progetto.

ReferenceLinks

Object

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.

ReleaseApproval

Object

Nome	Tipo	Descrizione
approvalType	ApprovalType	Ottiene o imposta il tipo di approvazione.
approvedBy	IdentityRef	Ottiene l'identità approvata.
approver	IdentityRef	Ottiene o imposta l'identità che deve approvare.
attempt	integer (int32)	Ottiene o imposta un tentativo che specifica come quale tentativo di distribuzione appartiene.
comments	string	Ottiene o imposta i commenti per l'approvazione.
createdOn	string (date-time)	Ottiene la data in cui è stata creata.
history	ReleaseApprovalHistory[]	Ottiene la cronologia che specifica tutte le approvazioni associate all'approvazione.
id	integer (int32)	Ottiene l'identificatore univoco di questo campo.
isAutomated	boolean	Ottiene o imposta quando l'approvazione è automatizzata o meno.
modifiedOn	string (date-time)	Ottiene la data in cui è stata modificata.
rank	integer (int32)	Ottiene o imposta la classificazione che specifica l'ordine dell'approvazione. Ad esempio, lo stesso rango indica l'approvazione parallela.
release	ReleaseShallowReference	Ottiene releaseReference che specifica il riferimento della versione a cui è associata l'approvazione.
releaseDefinition	ReleaseDefinitionShallowReference	Ottiene releaseDefinitionReference che specifica il riferimento della definizione di versione a cui è associata l'approvazione.
releaseEnvironment	ReleaseEnvironmentShallowReference	Ottiene releaseEnvironmentReference che specifica il riferimento dell'ambiente di rilascio a cui è associata questa approvazione.
revision	integer (int32)	Ottiene il numero di revisione.
status	ApprovalStatus	Ottiene o imposta lo stato dell'approvazione.
url	string	Ottiene l'URL per accedere all'approvazione.

ReleaseApprovalHistory

Object

Nome	Tipo	Descrizione
approver	IdentityRef	Identità del responsabile approvazione.
changedBy	IdentityRef	Identità dell'oggetto che ha modificato l'approvazione.
comments	string	Commenti della cronologia approvazione.
createdOn	string (date-time)	Ora di creazione dell'approvazione.
modifiedOn	string (date-time)	Ora di modifica dell'approvazione.
revision	integer (int32)	Revisione della cronologia di approvazione.

ReleaseDefinitionShallowReference

Object

Nome	Tipo	Descrizione
_links	ReferenceLinks	Ottiene i collegamenti a risorse, API e viste correlate per la definizione di versione.
id	integer (int32)	Ottiene l'identificatore univoco della definizione di versione.
name	string	Ottiene o imposta il nome della definizione di versione.
path	string	Ottiene o imposta il percorso della definizione di versione.
projectReference	ProjectReference	Ottiene o imposta il riferimento al progetto.
url	string	Ottiene l'URL dell'API REST per accedere alla definizione di versione.

ReleaseEnvironmentShallowReference

Object

Nome	Tipo	Descrizione
_links	ReferenceLinks	Ottiene i collegamenti a risorse, API e viste correlate per l'ambiente di rilascio.
id	integer (int32)	Ottiene l'identificatore univoco dell'ambiente di rilascio.
name	string	Ottiene o imposta il nome dell'ambiente di rilascio.
url	string	Ottiene l'URL dell'API REST per accedere all'ambiente di rilascio.

ReleaseShallowReference

Object

Nome	Tipo	Descrizione
_links	ReferenceLinks	Ottiene i collegamenti a risorse, API e viste correlate per la versione.
id	integer (int32)	Ottiene l'identificatore univoco della versione.
name	string	Ottiene o imposta il nome della versione.
url	string	Ottiene l'URL dell'API REST per accedere alla versione.

Condividi tramite

Approvals - Update

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

oauth2

Ambiti

Esempio

Approve a release

Esempio di richiesta

Risposta di esempio

Definizioni

ApprovalStatus

ApprovalType

IdentityRef

ProjectReference

ReferenceLinks

ReleaseApproval

ReleaseApprovalHistory

ReleaseDefinitionShallowReference

ReleaseEnvironmentShallowReference

ReleaseShallowReference

Risorse aggiuntive