Approvals - Update

Reference

Service:: Release

API Version:: 5.0

Aktualizace stavu schválení

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
approvalId	path	True	integer int32	ID schválení.
organization	path	True	string	Název organizace Azure DevOps.
project	path	True	string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavena na hodnotu 5.0.

Text požadavku

Name	Typ	Description
approvalType	ApprovalType	Získá nebo nastaví typ schválení.
approvedBy	IdentityRef	Získá identitu, která schválila.
approver	IdentityRef	Získá nebo nastaví identitu, která by měla schválit.
attempt	integer	Získá nebo nastaví pokus, který určuje, který pokus o nasazení patří.
comments	string	Získá nebo nastaví komentáře ke schválení.
createdOn	string	Získá datum, kdy byl vytvořen.
history	ReleaseApprovalHistory[]	Získá historii, která určuje všechna schválení přidružená k tomuto schválení.
id	integer	Získá jedinečný identifikátor tohoto pole.
isAutomated	boolean	Získá nebo nastaví, protože schválení je automatizované nebo ne.
isNotificationOn	boolean
modifiedOn	string	Získá datum, kdy došlo k úpravě.
rank	integer	Získá nebo nastaví pořadí, které určuje pořadí schválení. Například stejné pořadí označuje paralelní schválení.
release	ReleaseShallowReference	Získá releaseReference, který určuje odkaz na verzi, ke které je toto schválení přidruženo.
releaseDefinition	ReleaseDefinitionShallowReference	Získá releaseDefinitionReference, který určuje odkaz na definici verze, ke které je přidruženo toto schválení.
releaseEnvironment	ReleaseEnvironmentShallowReference	Získá releaseEnvironmentReference, která určuje odkaz prostředí verze, ke kterému je toto schválení přidruženo.
revision	integer	Získá číslo revize.
status	ApprovalStatus	Získá nebo nastaví stav schválení.
trialNumber	integer
url	string	Získá adresu URL pro přístup ke schválení.

Odpovědi

Name	Typ	Description
200 OK	ReleaseApproval	úspěšná operace

Zabezpečení

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

Name	Description
vso.release_manage	Umožňuje číst, aktualizovat a odstraňovat artefakty vydaných verzí, včetně vydání, definic vydaných verzí a rozšíření verzí, a možnost zařadit novou verzi do fronty a schválit ji.

Příklady

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

Definice

Name	Description
ApprovalStatus	Získá nebo nastaví stav schválení.
ApprovalType	Získá nebo nastaví typ schválení.
IdentityRef
ProjectReference
ReferenceLinks	Třída představující kolekci odkazů REST.
ReleaseApproval
ReleaseApprovalHistory
ReleaseDefinitionShallowReference
ReleaseEnvironmentShallowReference
ReleaseShallowReference

ApprovalStatus

Získá nebo nastaví stav schválení.

Name	Typ	Description
approved	string
canceled	string
pending	string
reassigned	string
rejected	string
skipped	string
undefined	string

ApprovalType

Získá nebo nastaví typ schválení.

Name	Typ	Description
all	string
postDeploy	string
preDeploy	string
undefined	string

IdentityRef

Name	Typ	Description
_links	ReferenceLinks	Toto pole obsahuje nula nebo více zajímavých odkazů o předmětu grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto předmětu grafu.
descriptor	string	Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu napříč účty i organizacemi.
directoryAlias	string
displayName	string	Toto je jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Tato adresa URL je úplná trasa ke zdrojovému prostředku tohoto předmětu grafu.

ProjectReference

Name	Typ	Description
id	string	Získá jedinečný identifikátor tohoto pole.
name	string	Získá název projektu.

ReferenceLinks

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako jen pro čtení.

ReleaseApproval

Name	Typ	Description
approvalType	ApprovalType	Získá nebo nastaví typ schválení.
approvedBy	IdentityRef	Získá identitu, která schválila.
approver	IdentityRef	Získá nebo nastaví identitu, která by měla schválit.
attempt	integer	Získá nebo nastaví pokus, který určuje, který pokus o nasazení patří.
comments	string	Získá nebo nastaví komentáře ke schválení.
createdOn	string	Získá datum, kdy byl vytvořen.
history	ReleaseApprovalHistory[]	Získá historii, která určuje všechna schválení přidružená k tomuto schválení.
id	integer	Získá jedinečný identifikátor tohoto pole.
isAutomated	boolean	Získá nebo nastaví, protože schválení je automatizované nebo ne.
isNotificationOn	boolean
modifiedOn	string	Získá datum, kdy došlo k úpravě.
rank	integer	Získá nebo nastaví pořadí, které určuje pořadí schválení. Například stejné pořadí označuje paralelní schválení.
release	ReleaseShallowReference	Získá releaseReference, který určuje odkaz na verzi, ke které je toto schválení přidruženo.
releaseDefinition	ReleaseDefinitionShallowReference	Získá releaseDefinitionReference, který určuje odkaz na definici verze, ke které je přidruženo toto schválení.
releaseEnvironment	ReleaseEnvironmentShallowReference	Získá releaseEnvironmentReference, která určuje odkaz prostředí verze, ke kterému je toto schválení přidruženo.
revision	integer	Získá číslo revize.
status	ApprovalStatus	Získá nebo nastaví stav schválení.
trialNumber	integer
url	string	Získá adresu URL pro přístup ke schválení.

ReleaseApprovalHistory

Name	Typ	Description
approver	IdentityRef
changedBy	IdentityRef
comments	string
createdOn	string
modifiedOn	string
revision	integer

ReleaseDefinitionShallowReference

Name	Typ	Description
_links	ReferenceLinks	Získá odkazy na související prostředky, rozhraní API a zobrazení pro definici verze.
id	integer	Získá jedinečný identifikátor definice verze.
name	string	Získá nebo nastaví název definice vydané verze.
path	string	Získá nebo nastaví cestu k definici vydané verze.
projectReference	ProjectReference	Získá nebo nastaví odkaz na projekt.
url	string	Získá adresu URL rozhraní REST API pro přístup k definici verze.

ReleaseEnvironmentShallowReference

Name	Typ	Description
_links	ReferenceLinks	Získá odkazy na související prostředky, rozhraní API a zobrazení pro prostředí vydané verze.
id	integer	Získá jedinečný identifikátor prostředí verze.
name	string	Získá nebo nastaví název prostředí vydané verze.
url	string	Získá adresu URL rozhraní REST API pro přístup k prostředí vydané verze.

ReleaseShallowReference

Name	Typ	Description
_links	ReferenceLinks	Získá odkazy na související prostředky, rozhraní API a zobrazení pro vydání.
id	integer	Získá jedinečný identifikátor vydané verze.
name	string	Získá nebo nastaví název vydané verze.
url	string	Získá adresu URL rozhraní REST API pro přístup k vydané verzi.

Sdílet prostřednictvím