Approvals - Query

Başvuru

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Onayları Listele. Bu işlem hattında, bir kullanıcıda veya bir kaynakta bekleyen onaylar kümesi almak için kullanılabilir.

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?api-version=7.1-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?approvalIds={approvalIds}&$expand={$expand}&userIds={userIds}&state={state}&top={top}&api-version=7.1-preview.1

URI 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 '7.1-preview.1' olarak ayarlanmalıdır.
$expand	query		ApprovalDetailsExpandParameter	Döndürülen nesnelere bu ek ayrıntıları ekleyin.
approvalIds	query		string array (uuid)	Alınacak onay kimliklerinin listesi.
state	query		ApprovalStatus	Onay durumu. Sağlanmazsa herhangi bir durumun onaylarını döndürür
top	query		integer int32	Alınacak en fazla onay sayısı.
userIds	query		string array (string)	Atanan kullanıcı kimlikleri onaylarının listesi. Kullanıcı kimliklerini veya kullanıcı tanımlayıcılarını kabul eder.

Yanıtlar

Name	Tür	Description
200 OK	Approval[]	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.build	Derleme sonuçları, tanımlar ve istekler dahil olmak üzere derleme yapıtlarına erişme ve hizmet kancaları aracılığıyla derleme olayları hakkında bildirim alma olanağı verir.

Örnekler

Sample Request

HTTP

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?approvalIds=ee14f612-6838-43c0-b445-db238ef14153,06239b11-a904-43a1-be6a-0d44026bd121&api-version=7.1-preview.1

Sample Response

Status code:: 200

request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context

Response Body

{
  "count": 2,
  "value": [
    {
      "id": "ee14f612-6838-43c0-b445-db238ef14153",
      "steps": [],
      "status": "pending",
      "createdOn": "2020-11-19T08:14:49.58Z",
      "lastModifiedOn": "2020-11-19T08:14:49.5793622Z",
      "executionOrder": "anyOrder",
      "minRequiredApprovers": 1,
      "blockedApprovers": [],
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/approvals/ee14f612-6838-43c0-b445-db238ef14153"
        }
      }
    },
    {
      "id": "06239b11-a904-43a1-be6a-0d44026bd121",
      "steps": [],
      "status": "pending",
      "createdOn": "2020-11-19T09:39:35.28Z",
      "lastModifiedOn": "2020-11-19T09:39:35.2806001Z",
      "executionOrder": "anyOrder",
      "minRequiredApprovers": 1,
      "blockedApprovers": [],
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/approvals/06239b11-a904-43a1-be6a-0d44026bd121"
        }
      }
    }
  ]
}

Tanımlar

Name	Description
Approval
ApprovalDetailsExpandParameter	Döndürülen nesnelere bu ek ayrıntıları ekleyin.
ApprovalExecutionOrder	Onaylayanların eyleme dönüştürülebilecekleri sıra.
ApprovalPermissions	Onay nesnesi için geçerli kullanıcı izinleri.
ApprovalStatus	Onayın genel durumu.
ApprovalStep	Tek bir onay adımına ilişkin veriler.
ApprovalStepHistory	Tek bir onay adımı geçmişi için veriler.
IdentityRef
ReferenceLinks	REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf.

Approval

Name	Tür	Description
_links	ReferenceLinks	Onay nesnesine erişmek için bağlantıları alır.
blockedApprovers	IdentityRef[]	Onaylamasına izin verilmeyen kimlikler.
createdOn	string	Onayın oluşturulduğu tarih.
executionOrder	ApprovalExecutionOrder	Onaylayanların eyleme dönüştürülebilecekleri sıra.
id	string	Onayın benzersiz tanımlayıcısı.
instructions	string	Onaylayanlar için yönergeler.
lastModifiedOn	string	Onayın son değiştirildiği tarih.
minRequiredApprovers	integer	Onayın tamamı için onaylanması gereken en az onaylayan sayısı onaylandı olarak kabul edilir.
permissions	ApprovalPermissions	Onay nesnesi için geçerli kullanıcı izinleri.
status	ApprovalStatus	Onayın genel durumu.
steps	ApprovalStep[]	Onayla ilişkili adımların listesi.

ApprovalDetailsExpandParameter

Döndürülen nesnelere bu ek ayrıntıları ekleyin.

Name	Tür	Description
none	string	Ek özellik yok.
permissions	string	Onay nesnesi için geçerli kullanıcı izinlerini ekleyin.
steps	string	Onayla ilişkili onay adımlarını ekleyin.

ApprovalExecutionOrder

Onaylayanların eyleme dönüştürülebilecekleri sıra.

Name	Tür	Description
anyOrder	string	Onaylayanların herhangi bir sırada onay verebileceğini gösterir.
inSequence	string	Onaylayanların yalnızca sıralı bir sırada (atandıkları sipariş) onaylanabileceğini gösterir.

ApprovalPermissions

Onay nesnesi için geçerli kullanıcı izinleri.

Name	Tür	Description
none	string
queueBuild	string
reassign	string
resourceAdmin	string
update	string
view	string

ApprovalStatus

Onayın genel durumu.

Name	Tür	Description
all	string
approved	string	Onayın Onaylandı olduğunu gösterir.
canceled	string	Onayın İptal Edildi olduğunu gösterir.
completed	string
failed	string
pending	string	Onayın Beklemede olduğunu gösterir.
rejected	string	Onayın Reddedildi olduğunu gösterir.
skipped	string	Onayın Atlandı olduğunu gösterir.
timedOut	string	Onayın Zaman aşımına uğradı olduğunu gösterir.
undefined	string
uninitiated	string	Onayın Başlatılmadı olduğunu gösterir. Verilen onaylayanın henüz eyleme dönüştürülemez olduğu, yürütme sırasına göre olması durumunda kullanılır.

ApprovalStep

Tek bir onay adımına ilişkin veriler.

Name	Tür	Description
actualApprover	IdentityRef	Onaylayan kimlik.
assignedApprover	IdentityRef	Onaylaması gereken kimlik.
comment	string	Bu adımla ilişkili açıklama.
history	ApprovalStepHistory[]	Onay adımının geçmişi
initiatedOn	string	Bu adımın başlatıldığı zaman damgası.
lastModifiedBy	IdentityRef	Bu adımın son değiştirildiği kimlik.
lastModifiedOn	string	Bu adımın en son değiştirildiği zaman damgası.
order	integer	Onaylayanların onaylamasına izin verilen sipariş.
permissions	ApprovalPermissions	Adım için geçerli kullanıcı izinleri.
status	ApprovalStatus	Bu adımın geçerli durumu.

ApprovalStepHistory

Tek bir onay adımı geçmişi için veriler.

Name	Tür	Description
assignedTo	IdentityRef	Bu onay atanan kimlik
comment	string	Bu adım geçmişiyle ilişkili açıklama.
createdBy	IdentityRef	Bu adım geçmişinin oluşturulduğu kimlik.
createdOn	string	Bu adım geçmişinin oluşturulduğu zaman damgası.

IdentityRef

Name	Tür	Description
_links	ReferenceLinks	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.

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.