Records - Update

Reference

Služba:: Distributed Task

Verze rozhraní API:: 7.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

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 určení rozsahu požadavku
timelineId	path	True	string (uuid)	ID časové osy.
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
count	integer (int32)	Počet serializovaných položek.
value	string (T)	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

{
  "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 TimelineRecord.
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 jeden objekt JSON na drátu.

Issue

Objekt

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

Výčet

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

Hodnota	Description
error
warning

JObject

Objekt

Představuje objekt JSON.

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

TaskLogReference

Objekt

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 (int32)	ID protokolu úloh.
location	string	Adresa URL REST protokolu úloh.

TaskReference

Objekt

Odkaz na úkol.

Name	Typ	Description
id	string (uuid)	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ů task.json souboru.
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

Výčet

Hodnota	Description
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues

TimelineAttempt

Objekt

Pokus o aktualizaci záznamu TimelineRecord.

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

TimelineRecord

Objekt

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

Name	Typ	Description
agentSpecification	JObject	Specifikace agenta, na kterém běží úloha kanálu, v binárním formátu. Platí, pokud je záznam typu Úloha. Příklad: { "VMImage" : "windows-2019" }
attempt	integer (int32)	Početpokusůch
changeId	integer (int32)	ID, které spojuje všechny záznamy, se aktualizovalo současně. Tato hodnota se přebírá z ID změny časové osy.
currentOperation	string	Řetězec, který označuje aktuální operaci.
details	TimelineReference	Odkaz na dílčí časovou osu.
errorCount	integer (int32)	Počet chyb vytvořených touto operací.
finishTime	string (date-time)	Čas dokončení záznamu.
id	string (uuid)	ID záznamu.
identifier	string	Identifikátor řetězce, který je konzistentní napříč pokusy.
issues	Issue[]	Seznam problémů vytvořených touto operací
lastModified	string (date-time)	Č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 (int32)	Pořadová hodnota relativní k jiným záznamům na časové ose.
parentId	string (uuid)	ID nadřazeného záznamu. Příklad: Fáze je nadřazená fáze fáze, fáze je nadřazenou úlohou, úloha je nadřazenou úlohou.
percentComplete	integer (int32)	Procento dokončení záznamu
previousAttempts	TimelineAttempt[]	Předchozí pokusy o záznam.
queueId	integer (int32)	ID fronty, která propojuje projekty s fondy agentů, na kterých byla operace spuštěna. Platí, pokud je záznam typu Úloha.
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 (date-time)	Počáteční čas záznamu.
state	TimelineRecordState	Stav záznamu.
task	TaskReference	Odkaz na úkol. Platí, pokud 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 (int32)	Počet upozornění vytvořených touto operací.
workerName	string	Název agenta, na kterém je operace spuštěná. Platí, pokud je záznam typu Úloha.

TimelineRecordState

Výčet

Stav záznamu.

Hodnota	Description
completed
inProgress
pending

TimelineReference

Objekt

Odkaz na časovou osu

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

VariableValue

Objekt

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

Name	Typ	Description
isReadOnly	boolean	Určuje, zda lze proměnnou změnit během modulu runtime spouštění skriptu.
isSecret	boolean	Určuje, jestli má být proměnná zašifrovaná v klidovém stavu.
value	string	Hodnota proměnné.

VssJsonCollectionWrapper

Objekt

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

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