Approvals - List
Získání seznamu schválení
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/approvals?api-version=5.0
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/approvals?assignedToFilter={assignedToFilter}&statusFilter={statusFilter}&releaseIdsFilter={releaseIdsFilter}&typeFilter={typeFilter}&top={top}&continuationToken={continuationToken}&queryOrder={queryOrder}&includeMyGroupApprovals={includeMyGroupApprovals}&api-version=5.0
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
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. |
assigned
|
query |
string |
Schválení přiřazená tomuto uživateli. |
|
continuation
|
query |
integer int32 |
Získá schválení po poskytnutém tokenu pokračování. |
|
include
|
query |
boolean |
"true", aby zahrnovala schválení mé skupiny. Výchozí hodnota je false. |
|
query
|
query |
Získá výsledky v definovaném pořadí vytvořených schválení. Výchozí hodnota je sestupná. |
||
release
|
query |
string array (int32) |
Schválení pro ID verzí uvedená ve filtru. Více vydaných verzí je možné uvést tak, že je oddělíte pomocí ,, například releaseIdsFilter=1,2,3,4. |
|
status
|
query |
Schválení s tímto stavem. Výchozí hodnota je čekající na vyřízení. |
||
top
|
query |
integer int32 |
Počet schválení, která je potřeba získat. Výchozí hodnota je 50. |
|
type
|
query |
Schválení s tímto typem. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
ú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 | Umožňuje číst artefakty vydaných verzí, včetně verzí, definic vydaných verzí a prostředí vydaných verzí. |
Příklady
Pending for a specific release |
Pending for a specific user |
Pending for all users |
Pending for a specific release
Sample Request
GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/approvals?releaseIdsFilter=14&continuationToken=0&api-version=5.0
Sample Response
{
"count": 1,
"value": [
{
"id": 134,
"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"
},
"approvalType": "preDeploy",
"createdOn": "2017-06-01T09:42:16.053Z",
"modifiedOn": "2017-06-01T09:42:16.053Z",
"status": "pending",
"comments": "",
"isAutomated": false,
"isNotificationOn": true,
"trialNumber": 1,
"attempt": 1,
"rank": 1,
"release": {
"id": 14,
"name": "Release-14",
"url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/releases/14",
"_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": 53,
"name": "Dev",
"_links": {}
},
"url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/approvals/134"
}
]
}
Pending for a specific user
Sample Request
GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/approvals?assignedToFilter=Chuck Reinhart&continuationToken=0&api-version=5.0
Sample Response
{
"count": 2,
"value": [
{
"id": 2,
"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"
},
"approvalType": "preDeploy",
"createdOn": "2017-05-31T16:40:14.47Z",
"modifiedOn": "2017-05-31T16:40:14.47Z",
"status": "pending",
"comments": "",
"isAutomated": false,
"isNotificationOn": true,
"trialNumber": 1,
"attempt": 1,
"rank": 1,
"release": {
"id": 2,
"name": "Release-2",
"url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/releases/2",
"_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": 5,
"name": "Dev",
"_links": {}
},
"url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/approvals/2"
},
{
"id": 1,
"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"
},
"approvalType": "preDeploy",
"createdOn": "2017-05-31T16:40:04.577Z",
"modifiedOn": "2017-05-31T16:40:04.577Z",
"status": "pending",
"comments": "",
"isAutomated": false,
"isNotificationOn": true,
"trialNumber": 1,
"attempt": 1,
"rank": 1,
"release": {
"id": 1,
"name": "Release-1",
"url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/releases/1",
"_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": 1,
"name": "Dev",
"_links": {}
},
"url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/approvals/1"
}
]
}
Pending for all users
Sample Request
GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/approvals?continuationToken=0&api-version=5.0
Sample Response
{
"count": 2,
"value": [
{
"id": 2,
"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"
},
"approvalType": "preDeploy",
"createdOn": "2017-05-31T16:40:14.47Z",
"modifiedOn": "2017-05-31T16:40:14.47Z",
"status": "pending",
"comments": "",
"isAutomated": false,
"isNotificationOn": true,
"trialNumber": 1,
"attempt": 1,
"rank": 1,
"release": {
"id": 2,
"name": "Release-2",
"url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/releases/2",
"_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": 5,
"name": "Dev",
"_links": {}
},
"url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/approvals/2"
},
{
"id": 1,
"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"
},
"approvalType": "preDeploy",
"createdOn": "2017-05-31T16:40:04.577Z",
"modifiedOn": "2017-05-31T16:40:04.577Z",
"status": "pending",
"comments": "",
"isAutomated": false,
"isNotificationOn": true,
"trialNumber": 1,
"attempt": 1,
"rank": 1,
"release": {
"id": 1,
"name": "Release-1",
"url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/releases/1",
"_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": 1,
"name": "Dev",
"_links": {}
},
"url": "https://https://vsrm.dev.azure.com/fabrikamMyFirstProject/_apis/Release/approvals/1"
}
]
}
Definice
Name | Description |
---|---|
Approval |
Získá nebo nastaví stav schválení. |
Approval |
Získá nebo nastaví typ schválení. |
Identity |
|
Project |
|
Reference |
Třída představující kolekci odkazů REST. |
Release |
|
Release |
|
Release |
|
Release |
|
Release |
Získá výsledky v definovaném pořadí vytvořených schválení. Výchozí hodnota je sestupná. |
Release |
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 |
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 |
Získá nebo nastaví typ schválení. |
|
approvedBy |
Získá identitu, která schválila. |
|
approver |
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 |
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 |
Získá releaseReference, který určuje odkaz na verzi, ke které je toto schválení přidruženo. |
|
releaseDefinition |
Získá releaseDefinitionReference, který určuje odkaz na definici verze, ke které je přidruženo toto schválení. |
|
releaseEnvironment |
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 |
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 | ||
changedBy | ||
comments |
string |
|
createdOn |
string |
|
modifiedOn |
string |
|
revision |
integer |
ReleaseDefinitionShallowReference
Name | Typ | Description |
---|---|---|
_links |
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 |
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 |
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. |
ReleaseQueryOrder
Získá výsledky v definovaném pořadí vytvořených schválení. Výchozí hodnota je sestupná.
Name | Typ | Description |
---|---|---|
ascending |
string |
|
descending |
string |
ReleaseShallowReference
Name | Typ | Description |
---|---|---|
_links |
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. |
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro