Records - Update

Reference

Služba:: Distributed Task

Verze rozhraní API:: 7.1-preview.1

Aktualizujte záznamy časové osy, pokud už existují, jinak vytvořte nové záznamy pro stejnou časovou osu.

PATCH https://dev.azure.com/{organization}/{scopeIdentifier}/_apis/distributedtask/hubs/{hubName}/plans/{planId}/timelines/{timelineId}/records?api-version=7.1-preview.1

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
hubName	path	True	string	Název centra serveru. Běžné příklady: "build", "rm", "checks"
organization	path	True	string	Název organizace Azure DevOps.
planId	path	True	string uuid	ID plánu.
scopeIdentifier	path	True	string uuid	Identifikátor GUID projektu pro obor požadavku
timelineId	path	True	string uuid	ID časové osy.
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
count	integer	Počet serializovaných položek.
value	string	Serializovaná položka.

Odpovědi

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

Zabezpečení

accessToken

Osobní přístupový token. Jako heslo použijte libovolnou hodnotu pro uživatelské jméno a token.

Typ: basic

Příklady

Update timeline's records

Ukázkový požadavek

HTTP

PATCH https://dev.azure.com/{organization}/{scopeIdentifier}/_apis/distributedtask/hubs/{hubName}/plans/{planId}/timelines/{timelineId}/records?api-version=7.1-preview.1

{
  "value": [
    {
      "id": "5e6d5dbf-ac69-5f56-8b85-8e9038703a8b",
      "parentId": null,
      "type": null,
      "name": null,
      "startTime": null,
      "finishTime": null,
      "currentOperation": null,
      "percentComplete": null,
      "state": null,
      "result": null,
      "resultCode": null,
      "changeId": 0,
      "lastModified": "0001-01-01T00:00:00",
      "workerName": null,
      "log": {
        "path": "logs\\5e6d5dbf-ac69-5f56-8b85-8e9038703a8b",
        "createdOn": "0001-01-01T00:00:00",
        "lastChangedOn": "0001-01-01T00:00:00",
        "id": 0,
        "location": null
      },
      "details": null,
      "errorCount": null,
      "warningCount": null,
      "location": null,
      "attempt": 1,
      "identifier": null
    }
  ],
  "count": 1
}

Ukázková odpověď

Stavový kód:: 200

{
  "count": 1,
  "value": [
    {
      "id": "5e6d5dbf-ac69-5f56-8b85-8e9038703a8b",
      "parentId": "096e11e7-c8bb-5a90-1a73-4e639c9ea0f9",
      "type": "Task",
      "name": "Invoke REST API",
      "startTime": "2022-12-02T09:33:15.0466667Z",
      "finishTime": "2022-12-02T09:37:37.8433333Z",
      "currentOperation": null,
      "percentComplete": null,
      "state": "completed",
      "result": "succeeded",
      "resultCode": null,
      "changeId": 13,
      "lastModified": "0001-01-01T00:00:00",
      "workerName": null,
      "order": 1,
      "refName": "InvokeRESTAPI0",
      "log": {
        "id": 0,
        "location": "https://dev.azure.com/fabrikam/_apis/distributedtask/plans/787562d7-f1da-59cf-22c4-8a94fa784503/logs/0"
      },
      "details": null,
      "errorCount": 0,
      "warningCount": 0,
      "task": {
        "id": "9c3e8943-130d-4c78-ac63-8af81df62dfb",
        "name": "InvokeRESTAPI",
        "version": "1.198.0"
      },
      "location": "https://dev.azure.com/fabrikam/_apis/distributedtask/plans/787562d7-f1da-59cf-22c4-8a94fa784503/timelines/787562d7-f1da-59cf-22c4-8a94fa784503/records/5e6d5dbf-ac69-5f56-8b85-8e9038703a8b",
      "attempt": 1,
      "identifier": null
    }
  ]
}

Definice

Name	Description
Issue	Problém (chyba, upozornění) související se spuštěním kanálu
IssueType	Typ problému (chyba, upozornění).
JObject	Představuje objekt JSON.
TaskLogReference	Odkaz na protokol úloh. Tato třída obsahuje informace o výstupu vytištěného do konzoly protokolů záznamu časové osy během spuštění kanálu.
TaskReference	Odkaz na úkol.
TaskResult
TimelineAttempt	Pokus o aktualizaci záznamu časové osy.
TimelineRecord	Podrobné informace o provádění různých operací během spuštění kanálu
TimelineRecordState	Stav záznamu.
TimelineReference	Odkaz na časovou osu.
VariableValue	Třída obálky pro obecnou proměnnou.
VssJsonCollectionWrapper	Tato třída se používá k serializaci kolekcí jako jednoho objektu JSON na drátu.

Issue

Object

Problém (chyba, upozornění) související se spuštěním kanálu

Name	Typ	Description
category	string	Kategorie problému. Příklad: Kód – odkazuje na chyby kompilace Příklad: Obecné – odkazuje na obecné chyby.
data	object	Slovník obsahující podrobnosti o problému.
message	string	Popis problému.
type	IssueType	Typ problému (chyba, upozornění).

IssueType

Enumeration

Typ problému (chyba, upozornění).

Hodnota	Description
error
warning

JObject

Object

Představuje objekt JSON.

Name	Typ	Description
item	string
type	string	Získá typ uzlu pro tento JToken.

TaskLogReference

Object

Odkaz na protokol úloh. Tato třída obsahuje informace o výstupu vytištěného do konzoly protokolů záznamu časové osy během spuštění kanálu.

Name	Typ	Description
id	integer	ID protokolu úloh.
location	string	Adresa URL REST protokolu úloh.

TaskReference

Object

Odkaz na úkol.

Name	Typ	Description
id	string	ID definice úkolu. Odpovídá hodnotě ID souboru task.json. Příklad: CmdLineV2 { "id": "D9BAFED4-0B18-4F58-968D-86655B4D2CE9" }
inputs	object	Slovník vstupů specifických pro definici úkolu. Odpovídá hodnotě vstupů souboru task.json.
name	string	Název definice úkolu. Odpovídá hodnotě názvu souboru task.json. Příklad: CmdLineV2 { "name": "CmdLine" }
version	string	Verze definice úlohy. Odpovídá hodnotě verze souboru task.json. Příklad: CmdLineV2 { "version": { "Major": 2, "Minor": 212, "Patch": 0 } }

TaskResult

Enumeration

Hodnota	Description
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues

TimelineAttempt

Object

Pokus o aktualizaci záznamu časové osy.

Name	Typ	Description
attempt	integer	Pokus o záznam.
identifier	string	Jedinečný identifikátor záznamu
recordId	string	Identifikátor záznamu umístěný v zadané časové ose.
timelineId	string	Identifikátor časové osy, který vlastní záznam představující tento pokus.

TimelineRecord

Object

Podrobné informace o provádění různých operací během spuštění kanálu

Name	Typ	Description
agentSpecification	JObject	Specifikace agenta, který spouští úlohu kanálu, v binárním formátu. Platí, pokud je záznam typu Job. Příklad: { "VMImage" : "windows-2019" }
attempt	integer	Počet pokusů o záznam.
changeId	integer	ID propojující všechny záznamy se aktualizovalo současně. Tato hodnota je převzata z Hodnoty ChangeId časové osy.
currentOperation	string	Řetězec, který označuje aktuální operaci.
details	TimelineReference	Odkaz na dílčí časovou osu.
errorCount	integer	Počet chyb způsobených touto operací.
finishTime	string	Čas dokončení záznamu.
id	string	ID záznamu.
identifier	string	Identifikátor řetězce, který je konzistentní napříč pokusy.
issues	Issue[]	Seznam problémů způsobených touto operací
lastModified	string	Čas poslední změny záznamu.
location	string	Adresa URL REST záznamu.
log	TaskLogReference	Odkaz na protokol vytvořený touto operací.
name	string	Název záznamu.
order	integer	Řadová hodnota relativní k jiným záznamům na časové ose.
parentId	string	ID nadřazeného záznamu. Příklad: Fáze je nadřazená fáze, fáze je nadřazená úloha, úloha je nadřazená úkolu.
percentComplete	integer	Procento dokončení záznamu
previousAttempts	TimelineAttempt[]	Předchozí pokusy o záznam.
queueId	integer	ID fronty, která propojuje projekty s fondy agentů, ve kterých se operace spustila. Platí, pokud je záznam typu Job.
refName	string	Název odkazovaného záznamu.
result	TaskResult	Výsledek záznamu.
resultCode	string	Vyhodnocení předdefinovaných podmínek po dokončení operace záznamu. Příklad: Vyhodnocení `succeeded()`, výsledek = pravda Příklad: Vyhodnocení `and(succeeded(), eq(variables['system.debug'], False))`, Výsledek = Nepravda
startTime	string	Počáteční čas záznamu.
state	TimelineRecordState	Stav záznamu.
task	TaskReference	Odkaz na úkol. Platí, když je záznam typu Úkol.
type	string	Typ operace, kterou záznam sleduje. Příklad: Fáze, Fáze, Úloha, Úkol...
variables	<string, VariableValue>	Proměnné záznamu.
warningCount	integer	Počet upozornění vygenerovaných touto operací
workerName	string	Název agenta, který operaci spouští. Platí, pokud je záznam typu Job.

TimelineRecordState

Enumeration

Stav záznamu.

Hodnota	Description
completed
inProgress
pending

TimelineReference

Object

Odkaz na časovou osu.

Name	Typ	Description
changeId	integer	ID změny.
id	string	ID časové osy.
location	string	Adresa URL REST časové osy.

VariableValue

Object

Třída obálky pro obecnou proměnnou.

Name	Typ	Description
isReadOnly	boolean	Označuje, jestli je možné proměnnou změnit během běhu spouštění skriptu.
isSecret	boolean	Určuje, jestli má být proměnná šifrovaná v neaktivním stavu.
value	string	Hodnota proměnné.

VssJsonCollectionWrapper

Object

Tato třída se používá k serializaci kolekcí jako jednoho objektu JSON na drátu.

Name	Typ	Description
count	integer	Počet serializovaných položek.
value	string	Serializovaná položka.

Sdílet prostřednictvím

Records - Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

accessToken

Příklady

Update timeline's records

Ukázkový požadavek

Ukázková odpověď

Definice

Issue

IssueType

JObject

TaskLogReference

TaskReference

TaskResult

TimelineAttempt

TimelineRecord

TimelineRecordState

TimelineReference

VariableValue

VssJsonCollectionWrapper

Další materiály