Approvals - Update

Reference

Služba:: Release

Verze rozhraní API:: 7.1

Aktualizace stavu schválení

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

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. Pokud chcete použít tuto verzi rozhraní API, měla by být nastavená na hodnotu 7.1.

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 (int32)	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 (date-time)	Získá datum, ke kterému se vytvořilo.
history	ReleaseApprovalHistory[]	Získá historii, která určuje všechna schválení přidružená k tomuto schválení.
id	integer (int32)	Získá jedinečný identifikátor tohoto pole.
isAutomated	boolean	Získá nebo nastaví, protože schválení je automatizované nebo ne.
modifiedOn	string (date-time)	Získá datum, kdy byl změněn.
rank	integer (int32)	Získá nebo nastaví pořadí, které určuje pořadí schválení. Například stejné pořadí označuje paralelní schvalování.
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 vydané verze, ke které je toto schválení přidruženo.
releaseEnvironment	ReleaseEnvironmentShallowReference	Získá releaseEnvironmentReference, která určuje odkaz na prostředí verze, ke kterému je toto schválení přidruženo.
revision	integer (int32)	Získá číslo revize.
status	ApprovalStatus	Získá nebo nastaví stav schválení.
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

Typ: oauth2
Tok: accessCode
URL autorizace: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL tokenu: 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

Rozsahy

Name	Description
vso.release_manage	Uděluje možnost číst, aktualizovat a odstraňovat artefakty vydané verze, včetně složek, vydaných verzí, definic vydaných verzí a prostředí vydaných verzí a schopnost zařadit do fronty a schválit novou verzi.

Příklady

Approve a release

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:: 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"
}

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

Výčet

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

Hodnota	Description
approved	Označuje schválení.
canceled	Označuje, že schválení je zrušeno.
pending	Označuje, že schválení čeká na vyřízení.
reassigned	Označuje, že se schválení znovu přiřazuje.
rejected	Označuje, že schválení je odmítnuto.
skipped	Označuje, že se schválení přeskočí.
undefined	Označuje, že schválení nemá nastavenou stav.

ApprovalType

Výčet

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

Hodnota	Description
all	Označuje všechna schválení.
postDeploy	Označuje schválení, která se spustila po nasazení.
preDeploy	Označuje schválení, která se spustila před nasazením.
undefined	Označuje, že typ schválení není nastaven.

IdentityRef

Objekt

Name	Typ	Description
_links	ReferenceLinks	Toto pole obsahuje nula nebo zajímavější odkazy na téma grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto tématu grafu.
descriptor	string	Popisovač je primární způsob, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejné téma grafu v rámci účtů i organizací.
directoryAlias	string	Zastaralé – Je možné načíst dotazováním uživatele Graphu, na který odkazuje položka "self" slovníku IdentityRef "_links".
displayName	string	Toto je ne jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém zprostředkovateli.
id	string
imageUrl	string	Zastaralé – k dispozici v položce avatar ve slovníku IdentityRef "_links"
inactive	boolean	Zastaralé – Lze načíst dotazem na stav členství v grafu odkazovaném v položce "membershipState" slovníku GraphUser "_links"
isAadIdentity	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Popisovač.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Popisovač.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Zastaralé – nepoužívá se ve většině existujících implementací ToIdentityRef
uniqueName	string	Zastaralé – místo toho použijte Domain+PrincipalName.
url	string	Tato adresa URL je úplná trasa ke zdrojovému prostředku tohoto předmětu grafu.

ProjectReference

Objekt

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

ReferenceLinks

Objekt

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

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

ReleaseApproval

Objekt

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 (int32)	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 (date-time)	Získá datum, ke kterému se vytvořilo.
history	ReleaseApprovalHistory[]	Získá historii, která určuje všechna schválení přidružená k tomuto schválení.
id	integer (int32)	Získá jedinečný identifikátor tohoto pole.
isAutomated	boolean	Získá nebo nastaví, protože schválení je automatizované nebo ne.
modifiedOn	string (date-time)	Získá datum, kdy byl změněn.
rank	integer (int32)	Získá nebo nastaví pořadí, které určuje pořadí schválení. Například stejné pořadí označuje paralelní schvalování.
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 vydané verze, ke které je toto schválení přidruženo.
releaseEnvironment	ReleaseEnvironmentShallowReference	Získá releaseEnvironmentReference, která určuje odkaz na prostředí verze, ke kterému je toto schválení přidruženo.
revision	integer (int32)	Získá číslo revize.
status	ApprovalStatus	Získá nebo nastaví stav schválení.
url	string	Získá adresu URL pro přístup ke schválení.

ReleaseApprovalHistory

Objekt

Name	Typ	Description
approver	IdentityRef	Identita schvalovatele.
changedBy	IdentityRef	Identita objektu, který změnil schválení
comments	string	Komentáře k historii schválení
createdOn	string (date-time)	Čas vytvoření tohoto schválení
modifiedOn	string (date-time)	Čas změny tohoto schválení
revision	integer (int32)	Revize historie schválení

ReleaseDefinitionShallowReference

Objekt

Name	Typ	Description
_links	ReferenceLinks	Získá odkazy na související prostředky, rozhraní API a zobrazení pro definici verze.
id	integer (int32)	Získá jedinečný identifikátor definice vydané verze.
name	string	Získá nebo nastaví název definice vydané verze.
path	string	Získá nebo nastaví cestu definice 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 vydané verze.

ReleaseEnvironmentShallowReference

Objekt

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

ReleaseShallowReference

Objekt

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

Sdílet prostřednictvím

Approvals - Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

oauth2

Rozsahy

Příklady

Approve a release

Ukázkový požadavek

Ukázková odpověď

Definice

ApprovalStatus

ApprovalType

IdentityRef

ProjectReference

ReferenceLinks

ReleaseApproval

ReleaseApprovalHistory

ReleaseDefinitionShallowReference

ReleaseEnvironmentShallowReference

ReleaseShallowReference

Další materiály