Approvals - Update

Reference

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Aktualizace schválení.

PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?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. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.1.

Text požadavku

Name	Typ	Description
body	ApprovalUpdateParameters[]

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_execute	Uděluje možnost přístupu k artefaktům sestavení, včetně výsledků sestavení, definic a požadavků, a možnost zařadit sestavení do fronty, aktualizovat vlastnosti sestavení a přijímat oznámení o událostech sestavení prostřednictvím připojení služeb.
vso.pipelineresources_use	Uděluje možnost schválit žádost kanálu o použití chráněného prostředku: fond agentů, prostředí, fronta, úložiště, zabezpečené soubory, připojení služby a skupina proměnných.

Příklady

Sample Request

HTTP

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

[
  {
    "approvalId": "aab27959-a5be-4ee3-97ca-f19b3602cd2f",
    "comment": "Approving",
    "status": "approved"
  }
]

Sample Response

Status code:: 200

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

Response Body

{
  "count": 1,
  "value": [
    {
      "id": "aab27959-a5be-4ee3-97ca-f19b3602cd2f",
      "steps": [
        {
          "assignedApprover": {
            "displayName": "User Name",
            "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
            "uniqueName": "uniqueName",
            "descriptor": "Descriptor"
          },
          "actualApprover": {
            "displayName": "User Name",
            "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
            "uniqueName": "uniqueName",
            "descriptor": "Descriptor"
          },
          "status": "approved",
          "comment": "Approving",
          "lastModifiedOn": "2020-11-19T09:57:54.252505Z",
          "order": 1,
          "lastModifiedBy": {
            "displayName": "User Name",
            "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
            "uniqueName": "uniqueName",
            "descriptor": "Descriptor"
          },
          "initiatedOn": "2020-11-19T09:51:16.7045043Z",
          "history": []
        }
      ],
      "status": "approved",
      "createdOn": "2020-11-19T09:51:16.703Z",
      "lastModifiedOn": "2020-11-19T09:57:54.252505Z",
      "executionOrder": "anyOrder",
      "minRequiredApprovers": 1,
      "blockedApprovers": [],
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/approvals/aab27959-a5be-4ee3-97ca-f19b3602cd2f"
        }
      }
    }
  ]
}

Definice

Name	Description
Approval
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 jednotlivých kroků schválení.
ApprovalUpdateParameters	Data pro aktualizaci objektu schválení nebo jeho jednotlivého kroku
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é nejsou povoleny ke 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 schvalovat celé schválení, aby bylo 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í

ApprovalExecutionOrder

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

Name	Typ	Description
anyOrder	string	Označuje, že schvalovatelé můžou schvalovat v libovolném pořadí.
inSequence	string	Označuje, že schvalovatelé můžou schvalovat pouze v sekvenční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í je zamí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 nezasvěcené. 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á by měla schválit.
comment	string	Komentář přidružený k tomuto kroku
history	ApprovalStepHistory[]	Historie kroku schválení
initiatedOn	string	Časové razítko, ve kterém 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 jednotlivých kroků 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 tato historie kroků vytvořena.
createdOn	string	Časové razítko, ve kterém byla vytvořena historie tohoto kroku.

ApprovalUpdateParameters

Data pro aktualizaci objektu schválení nebo jeho jednotlivého kroku

Name	Typ	Description
approvalId	string	ID schválení, které se má aktualizovat.
assignedApprover	IdentityRef	Aktuální schvalovatel.
comment	string	Získá nebo nastaví komentář.
reassignTo	IdentityRef	Znovu přiřazený schvalovatel.
status	ApprovalStatus	Získá nebo nastaví stav.

IdentityRef

Name	Typ	Description
_links	ReferenceLinks	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	Zastaralé – lze načíst dotazem uživatele Graphu, na který odkazuje položka "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é – lze načíst dotazem na stav členství graphu, na který odkazuje položka membershipState slovníku GraphUser "_links".
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ě 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.

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í.

Sdílet prostřednictvím