Approvals - List
Onayların listesini alma
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/approvals?api-version=6.0GET 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=6.0URI Parametreleri
| Name | İçinde | Gerekli | Tür | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps kuruluşunun adı. |
|
project
|
path | True |
string |
Proje Kimliği veya proje adı |
|
api-version
|
query | True |
string |
Kullanılacak API'nin sürümü. Bu, api'nin bu sürümünü kullanmak için '6.0' olarak ayarlanmalıdır. |
|
assigned
|
query |
string |
Bu kullanıcıya atanan onaylar. |
|
|
continuation
|
query |
integer int32 |
Sağlanan devamlılık belirtecinin ardından onayları alır. |
|
|
include
|
query |
boolean |
Grup onaylarımı dahil etmek için 'true'. Varsayılan değer 'false'tur. |
|
|
query
|
query |
Sonuçları, oluşturulan onayların tanımlı sırasına göre alır. Varsayılan değer 'azalan'dır. |
||
|
release
|
query |
string array (int32) |
Filtrede belirtilen yayın kimlikleri için onaylar. Birden çok sürüm , örneğin releaseIdsFilter=1,2,3,4 ile ayrılarak belirtilebilir. |
|
|
status
|
query |
Bu durumdaki onaylar. Varsayılan değer 'beklemede'dir. |
||
|
top
|
query |
integer int32 |
Alınacak onayların sayısı. Varsayılan değer 50'dir. |
|
|
type
|
query |
Bu tür onay. |
Yanıtlar
| Name | Tür | Description |
|---|---|---|
| 200 OK |
başarılı işlem |
Güvenlik
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 | Klasörler, yayınlar, yayın tanımları ve yayın ortamı dahil olmak üzere yayın yapıtlarını okuma yeteneği verir. |
Örnekler
| 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=6.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://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/releases/14",
"_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": 53,
"name": "Dev",
"_links": {}
},
"url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_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=6.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://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/releases/2",
"_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": 5,
"name": "Dev",
"_links": {}
},
"url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_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://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/releases/1",
"_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": 1,
"name": "Dev",
"_links": {}
},
"url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_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=6.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://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/releases/2",
"_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": 5,
"name": "Dev",
"_links": {}
},
"url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_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://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/releases/1",
"_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": 1,
"name": "Dev",
"_links": {}
},
"url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/approvals/1"
}
]
}Tanımlar
| Name | Description |
|---|---|
|
Approval |
Onay durumunu alır veya ayarlar. |
|
Approval |
Onay türünü alır veya ayarlar. |
|
Identity |
|
|
Project |
|
|
Reference |
REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf. |
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
|
|
Release |
Sonuçları, oluşturulan onayların tanımlı sırasına göre alır. Varsayılan değer 'azalan'dır. |
|
Release |
ApprovalStatus
Onay durumunu alır veya ayarlar.
| Name | Tür | Description |
|---|---|---|
| approved |
string |
Onay onayını gösterir. |
| canceled |
string |
Onayın iptal olduğunu gösterir. |
| pending |
string |
Onayın beklemede olduğunu gösterir. |
| reassigned |
string |
Onayın yeniden atandiğini gösterir. |
| rejected |
string |
Onayın reddedildiğini gösterir. |
| skipped |
string |
Onayın atlanmış olduğunu gösterir. |
| undefined |
string |
Onayda durum ayarlanmadığını gösterir. |
ApprovalType
Onay türünü alır veya ayarlar.
| Name | Tür | Description |
|---|---|---|
| all |
string |
Tüm onayları gösterir. |
| postDeploy |
string |
Dağıtımdan sonra yürütülen onayları gösterir. |
| preDeploy |
string |
Dağıtımdan önce yürütülen onayları gösterir. |
| undefined |
string |
Onay türünün ayarlanmadığını gösterir. |
IdentityRef
| Name | Tür | Description |
|---|---|---|
| _links |
Bu alan, grafik konusuyla ilgili sıfır veya daha fazla ilgi çekici bağlantı içerir. Bu bağlantılar, bu grafik konusu hakkında ek ilişkiler veya daha ayrıntılı bilgi edinmek için çağrılabilir. |
|
| descriptor |
string |
Tanımlayıcı, sistem çalışırken graf konusuna başvurmanın birincil yoludur. Bu alan, hem Hesaplar hem de Kuruluşlar genelinde aynı graf konusunu benzersiz olarak tanımlar. |
| directoryAlias |
string |
Kullanım dışı - IdentityRef "_links" sözlüğündeki "self" girişinde başvuruda bulunılan Graph kullanıcısı sorgulanarak alınabilir |
| displayName |
string |
Bu, grafik konusunun benzersiz olmayan görünen adıdır. Bu alanı değiştirmek için kaynak sağlayıcıdaki değerini değiştirmeniz gerekir. |
| id |
string |
|
| imageUrl |
string |
Kullanım dışı - IdentityRef "_links" sözlüğündeki "avatar" girişinde kullanılabilir |
| inactive |
boolean |
Kullanım dışı - GraphUser "_links" sözlüğündeki "membershipState" girdisinde başvurulan Graph üyelik durumu sorgulanarak alınabilir |
| isAadIdentity |
boolean |
Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
| isContainer |
boolean |
Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsGroupType) |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
Kullanım dışı - ToIdentityRef'in önceden var olan uygulamalarının çoğunda kullanımda değil |
| uniqueName |
string |
Kullanım dışı - bunun yerine Domain+PrincipalName kullanın |
| url |
string |
Bu URL, bu grafik konusunun kaynak kaynağına giden tam yoldur. |
ProjectReference
| Name | Tür | Description |
|---|---|---|
| id |
string |
Bu alanın benzersiz tanımlayıcısını alır. |
| name |
string |
Projenin adını alır. |
ReferenceLinks
REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf.
| Name | Tür | Description |
|---|---|---|
| links |
object |
Bağlantıların salt okunur görünümü. Başvuru bağlantıları salt okunur olduğundan, bunları yalnızca salt okunur olarak kullanıma açmak istiyoruz. |
ReleaseApproval
| Name | Tür | Description |
|---|---|---|
| approvalType |
Onay türünü alır veya ayarlar. |
|
| approvedBy |
Onaylayan kimliği alır. |
|
| approver |
Onaylaması gereken kimliği alır veya ayarlar. |
|
| attempt |
integer |
Ait olduğu dağıtım girişimini belirten denemeyi alır veya ayarlar. |
| comments |
string |
Onay için açıklamaları alır veya ayarlar. |
| createdOn |
string |
Oluşturulduğu tarihi alır. |
| history |
Bu onayla ilişkili tüm onayları belirten geçmişi alır. |
|
| id |
integer |
Bu alanın benzersiz tanımlayıcısını alır. |
| isAutomated |
boolean |
Onay otomatikleştirilmiş veya değil olarak alır veya ayarlar. |
| modifiedOn |
string |
Değiştirildiği tarihi alır. |
| rank |
integer |
Onayın sırasını belirten dereceyi alır veya ayarlar. Örneğin, aynı derece paralel onayı belirtir. |
| release |
Bu onayın ilişkilendirildiği sürümün başvurularını belirten releaseReference'ı alır. |
|
| releaseDefinition |
Bu onayın ilişkilendirildiği yayın tanımının başvurularını belirten releaseDefinitionReference'ı alır. |
|
| releaseEnvironment |
Bu onayın ilişkilendirildiği yayın ortamının başvurularını belirten releaseEnvironmentReference'ı alır. |
|
| revision |
integer |
Düzeltme numarasını alır. |
| status |
Onay durumunu alır veya ayarlar. |
|
| url |
string |
Onaya erişmek için URL'yi alır. |
ReleaseApprovalHistory
| Name | Tür | Description |
|---|---|---|
| approver |
Onaylayanın kimliği. |
|
| changedBy |
Onayını değiştiren nesnenin kimliği. |
|
| comments |
string |
Onay geçmişi açıklamaları. |
| createdOn |
string |
Bu onayın oluşturulduğu zaman. |
| modifiedOn |
string |
Bu onayın değiştirildiği zaman. |
| revision |
integer |
Onay geçmişi düzeltmesi. |
ReleaseDefinitionShallowReference
| Name | Tür | Description |
|---|---|---|
| _links |
Yayın tanımı için ilgili kaynaklara, API'lere ve görünümlere bağlantıları alır. |
|
| id |
integer |
Yayın tanımının benzersiz tanımlayıcısını alır. |
| name |
string |
Yayın tanımının adını alır veya ayarlar. |
| path |
string |
Yayın tanımının yolunu alır veya ayarlar. |
| projectReference |
Proje başvurularını alır veya ayarlar. |
|
| url |
string |
Yayın tanımına erişmek için REST API URL'sini alır. |
ReleaseEnvironmentShallowReference
| Name | Tür | Description |
|---|---|---|
| _links |
Yayın ortamı için ilgili kaynaklara, API'lere ve görünümlere bağlantıları alır. |
|
| id |
integer |
Yayın ortamının benzersiz tanımlayıcısını alır. |
| name |
string |
Yayın ortamının adını alır veya ayarlar. |
| url |
string |
Yayın ortamına erişmek için REST API URL'sini alır. |
ReleaseQueryOrder
Sonuçları, oluşturulan onayların tanımlı sırasına göre alır. Varsayılan değer 'azalan'dır.
| Name | Tür | Description |
|---|---|---|
| ascending |
string |
Sonuçları artan düzende döndürür. |
| descending |
string |
Sonuçları azalan sırada döndürür. |
ReleaseShallowReference
| Name | Tür | Description |
|---|---|---|
| _links |
Yayın için ilgili kaynaklara, API'lere ve görünümlere bağlantıları alır. |
|
| id |
integer |
Yayının benzersiz tanımlayıcısını alır. |
| name |
string |
Yayının adını alır veya ayarlar. |
| url |
string |
Yayına erişmek için REST API URL'sini alır. |
Geri Bildirim
Çok yakında: 2024 boyunca, içerik için geri bildirim mekanizması olarak GitHub Sorunları’nı kullanımdan kaldıracak ve yeni bir geri bildirim sistemiyle değiştireceğiz. Daha fazla bilgi için bkz. https://aka.ms/ContentUserFeedback.
Gönderin ve geri bildirimi görüntüleyin