Approvals - Query

Reference

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Vypsat schválení. Dá se použít k získání sady čekajících schválení v kanálu, pro uživatele nebo pro prostředek.

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

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. Tato verze rozhraní API by měla být nastavená na 7.1-preview.1.
$expand	query		ApprovalDetailsExpandParameter	Do vrácených objektů zahrňte tyto další podrobnosti.
approvalIds	query		string array (uuid)	Seznam ID schválení, která chcete získat.
state	query		ApprovalStatus	Stav schválení. Vrátí schválení libovolného stavu, pokud není zadaný.
top	query		integer int32	Maximální počet schválení, která je potřeba získat.
userIds	query		string array (string)	Seznam schválení ID uživatelů přiřazených k Přijímá id uživatele nebo popisovače uživatelů.

Odpovědi

Name	Typ	Description
200 OK	Approval[]	ú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.build	Uděluje možnost přístupu k artefaktům sestavení, včetně výsledků sestavení, definic a požadavků, a možnost přijímat oznámení o událostech sestavení prostřednictvím volání služeb.

Příklady

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

Definice

Name	Description
Approval
ApprovalDetailsExpandParameter	Do vrácených objektů zahrňte tyto další podrobnosti.
ApprovalExecutionOrder	Pořadí, ve kterém budou schvalovatelé moci reagovat.
ApprovalPermissions	Aktuální uživatelská oprávnění pro objekt schválení.
ApprovalStatus	Celkový stav schválení
ApprovalStep	Data pro jeden krok schválení.
ApprovalStepHistory	Data pro historii jednoho kroku schválení.
IdentityRef
ReferenceLinks	Třída představující kolekci odkazů REST.

Approval

Name	Typ	Description
_links	ReferenceLinks	Získá odkazy pro přístup k objektu schválení.
blockedApprovers	IdentityRef[]	Identity, které nemají povolené schválení.
createdOn	string	Datum vytvoření schválení
executionOrder	ApprovalExecutionOrder	Pořadí, ve kterém budou schvalovatelé moci reagovat.
id	string	Jedinečný identifikátor schválení.
instructions	string	Pokyny pro schvalovatele
lastModifiedOn	string	Datum, kdy bylo schválení naposledy změněno.
minRequiredApprovers	integer	Minimální počet schvalovatelů, kteří by měli schválit celé schválení, které má být považováno za schválené.
permissions	ApprovalPermissions	Aktuální uživatelská oprávnění pro objekt schválení.
status	ApprovalStatus	Celkový stav schválení
steps	ApprovalStep[]	Seznam kroků přidružených ke schválení

ApprovalDetailsExpandParameter

Do vrácených objektů zahrňte tyto další podrobnosti.

Name	Typ	Description
none	string	Žádné další vlastnosti.
permissions	string	Zahrnout aktuální uživatelská oprávnění pro objekt schválení.
steps	string	Zahrňte kroky schválení přidružené ke schválení.

ApprovalExecutionOrder

Pořadí, ve kterém budou schvalovatelé moci reagovat.

Name	Typ	Description
anyOrder	string	Označuje, že schvalovatelé můžou schválit v libovolném pořadí.
inSequence	string	Určuje, že schvalovatelé mohou schvalovat pouze v postupném pořadí (pořadí, ve kterém byli přiřazeni).

ApprovalPermissions

Aktuální uživatelská oprávnění pro objekt schválení.

Name	Typ	Description
none	string
queueBuild	string
reassign	string
resourceAdmin	string
update	string
view	string

ApprovalStatus

Celkový stav schválení

Name	Typ	Description
all	string
approved	string	Označuje, že schválení je schváleno.
canceled	string	Označuje, že schválení je zrušeno.
completed	string
failed	string
pending	string	Označuje, že schválení čeká na vyřízení.
rejected	string	Označuje, že schválení bylo odmítnuto.
skipped	string	Označuje, že schválení je přeskočeno.
timedOut	string	Označuje vypršení časového limitu schválení.
undefined	string
uninitiated	string	Označuje, že schválení je nezahajováno. Používá se v případě pořadí provádění v pořadí, kdy daný schvalovatel ještě není možné reagovat.

ApprovalStep

Data pro jeden krok schválení.

Name	Typ	Description
actualApprover	IdentityRef	Identita, která schválila
assignedApprover	IdentityRef	Identita, která má schválit
comment	string	Komentář přidružený k tomuto kroku
history	ApprovalStepHistory[]	Historie kroku schválení
initiatedOn	string	Časové razítko, kdy byl tento krok zahájen.
lastModifiedBy	IdentityRef	Identita, podle které byl tento krok naposledy změněn.
lastModifiedOn	string	Časové razítko, ve kterém byl tento krok naposledy změněn.
order	integer	Pořadí, ve kterém mohou schvalovatelé schvalovat.
permissions	ApprovalPermissions	Aktuální uživatelská oprávnění pro krok.
status	ApprovalStatus	Aktuální stav tohoto kroku.

ApprovalStepHistory

Data pro historii jednoho kroku schválení.

Name	Typ	Description
assignedTo	IdentityRef	Identita, které bylo toto schválení přiřazeno
comment	string	Komentář přidružený k této historii kroků
createdBy	IdentityRef	Identita, pomocí které byla vytvořena historie tohoto kroku.
createdOn	string	Časové razítko, ve kterém byla vytvořena historie tohoto kroku.

IdentityRef

Name	Typ	Description
_links	ReferenceLinks	Toto pole neobsahuje žádný nebo více zajímavých odkazů 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 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 v rámci účtů i organizací.
directoryAlias	string	Zastaralé – Dá se načíst dotazem na uživatele Graphu odkazovaného v položce "self" slovníku IdentityRef "_links"
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	Zastaralé – k dispozici v položce "avatar" ve slovníku IdentityRef "_links"
inactive	boolean	Zastaralé – Můžete ho načíst dotazem na stav členství v Graphu, na který odkazuje položka membershipState slovníku _links GraphUser.
isAadIdentity	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Zastaralé – Lze odvodit z typu předmětu popisovače (Descriptor.IsGroupType).
isDeletedInOrigin	boolean
profileUrl	string	Zastaralé – nepoužívá se ve většině dříve existujících implementací ToIdentityRef
uniqueName	string	Zastaralé – místo toho použijte Domain+PrincipalName.
url	string	Tato adresa URL představuje úplnou trasu ke zdrojovému prostředku tohoto předmětu grafu.

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 odkazy jen pro čtení.

Sdílet prostřednictvím