Approvals - Update

Reference

Služba:: Approvals And Checks

Verze rozhraní API:: 7.1

Aktualizace schválení

PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?api-version=7.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. Pokud chcete použít tuto verzi rozhraní API, měla by být nastavená na hodnotu 7.1.

Text požadavku

Name	Typ	Description
body	ApprovalUpdateParameters[]

Odpovědi

Name	Typ	Description
200 OK	Approval[]	úspěšná operace

Zabezpečení

oauth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL tokenu: 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

Rozsahy

Name	Description
vso.build_execute	Uděluje možnost získat přístup 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 možnost přijímat oznámení o událostech sestavení prostřednictvím volání 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

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:: 200

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

{
  "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 jednoho kroku schválení
ApprovalUpdateParameters	Data pro aktualizaci schvalovacího objektu nebo jeho jednotlivého kroku
IdentityRef
ReferenceLinks	Třída představující kolekci odkazů REST.

Approval

Objekt

Name	Typ	Description
_links	ReferenceLinks	Získá odkazy pro přístup k objektu schválení.
blockedApprovers	IdentityRef[]	Identity, které nesmějí schvalovat
createdOn	string (date-time)	Datum vytvoření schválení.
executionOrder	ApprovalExecutionOrder	Pořadí, ve kterém budou schvalovatelé moci reagovat.
id	string (uuid)	Jedinečný identifikátor schválení.
instructions	string	Pokyny pro schvalovatele
lastModifiedOn	string (date-time)	Datum poslední změny schválení.
minRequiredApprovers	integer (int32)	Minimální počet schvalovatelů, kteří by měli schválit 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

Výčet

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

Hodnota	Description
anyOrder	Označuje, že schvalovatelé můžou schvalovat v libovolném pořadí.
inSequence	Označuje, že schvalovatelé mohou schvalovat pouze v sekvenčním pořadí (pořadí, ve kterém byli přiřazeni).

ApprovalPermissions

Výčet

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

Hodnota	Description
none
queueBuild
reassign
resourceAdmin
update
view

ApprovalStatus

Výčet

Celkový stav schválení

Hodnota	Description
all
approved	Označuje, že schválení je schváleno.
canceled	Označuje, že schválení je zrušeno.
completed
failed
pending	Označuje, že schválení čeká na vyřízení.
rejected	Označuje, že schválení je odmítnuto.
skipped	Označuje, že schválení se přeskočí.
timedOut	Označuje, že schválení vypršel časový limit.
undefined
uninitiated	Označuje, že schválení není zahájeno. Používá se v případě pořadí provádění, kdy daný schvalovatel ještě není použitelný.

ApprovalStep

Objekt

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 (date-time)	Časové razítko, ve kterém byl tento krok zahájen.
lastModifiedBy	IdentityRef	Identita, o kterou byl tento krok naposledy změněn.
lastModifiedOn	string (date-time)	Časové razítko, ve kterém byl tento krok naposledy změněn.
order	integer (int32)	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

Objekt

Data pro historii jednoho kroku schválení

Name	Typ	Description
assignedTo	IdentityRef	Identita, která byla přiřazena k tomuto schválení
comment	string	Komentář přidružený k historii tohoto kroku
createdBy	IdentityRef	Identita, pomocí které byla vytvořena historie tohoto kroku
createdOn	string (date-time)	Časové razítko, ve kterém byla vytvořena historie tohoto kroku.

ApprovalUpdateParameters

Objekt

Data pro aktualizaci schvalovacího objektu nebo jeho jednotlivého kroku

Name	Typ	Description
approvalId	string (uuid)	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

Objekt

Name	Typ	Description
_links	ReferenceLinks	Toto pole obsahuje nula nebo zajímavější odkazy 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 tématu grafu.
descriptor	string	Popisovač je primární způsob, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejné téma grafu v rámci účtů i organizací.
directoryAlias	string	Zastaralé – Je možné načíst dotazováním uživatele Graphu, na který odkazuje položka "self" slovníku IdentityRef "_links".
displayName	string	Toto je ne jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém zprostředkovateli.
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í v grafu odkazovaném v položce "membershipState" slovníku GraphUser "_links"
isAadIdentity	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Popisovač.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Popisovač.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

Objekt

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Jen pro čtení odkazů. Vzhledem k tomu, že odkazy odkazy jsou jen pro čtení, chceme je zveřejnit jen pro čtení.

Sdílet prostřednictvím

Approvals - Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

oauth2

Rozsahy

Příklady

Ukázkový požadavek

Ukázková odpověď

Definice

Approval

ApprovalExecutionOrder

ApprovalPermissions

ApprovalStatus

ApprovalStep

ApprovalStepHistory

ApprovalUpdateParameters

IdentityRef

ReferenceLinks

Další materiály