Records - Update

Referenz

Service:: Distributed Task

API Version:: 7.1-preview.1

Aktualisieren Sie Zeitleiste Datensätze, falls sie bereits vorhanden sind, und erstellen Sie andernfalls neue Datensätze für dieselbe Zeitleiste.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
hubName	path	True	string	Der Name des Serverhubs. Häufige Beispiele: "build", "rm", "checks"
organization	path	True	string	Der Name der Azure DevOps-Organisation.
planId	path	True	string uuid	Die ID des Plans.
scopeIdentifier	path	True	string uuid	Die Projekt-GUID zum Bereich der Anforderung
timelineId	path	True	string uuid	Die ID des Zeitleiste.
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1-preview.1" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name	Typ	Beschreibung
count	integer	Die Anzahl der serialisierten Elemente.
value	string	Das serialisierte Element.

Antworten

Name	Typ	Beschreibung
200 OK	TimelineRecord[]	Erfolgreicher Vorgang

Sicherheit

accessToken

Persönliches Zugriffstoken. Verwenden Sie einen beliebigen Wert für den Benutzernamen und das Token als Kennwort.

Type: basic

Beispiele

Update timeline's records

Sample Request

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
}

Sample Response

Status code:: 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
    }
  ]
}

Definitionen

Name	Beschreibung
Issue	Ein Problem (Fehler, Warnung), das einer Pipelineausführung zugeordnet ist.
IssueType	Der Typ (Fehler, Warnung) des Problems.
JObject	Stellt ein JSON-Objekt dar.
TaskLogReference	Ein Verweis auf ein Aufgabenprotokoll. Diese Klasse enthält Informationen zu der Ausgabe, die während der Pipelineausführung in der Protokollkonsole des Zeitleiste Datensatzes ausgegeben wird.
TaskReference	Ein Verweis auf eine Aufgabe.
TaskResult
TimelineAttempt	Ein Versuch, einen Zeitachsendatensatz zu aktualisieren.
TimelineRecord	Ausführliche Informationen zur Ausführung verschiedener Vorgänge während der Pipelineausführung.
TimelineRecordState	Der Status des Datensatzes.
TimelineReference	Ein Verweis auf eine Zeitleiste.
VariableValue	Eine Wrapperklasse für eine generische Variable.
VssJsonCollectionWrapper	Diese Klasse wird verwendet, um Auflistungen als einzelnes JSON-Objekt im Wire zu serialisieren.

Issue

Ein Problem (Fehler, Warnung), das einer Pipelineausführung zugeordnet ist.

Name	Typ	Beschreibung
category	string	Die Kategorie des Problems. Beispiel: Code : bezieht sich auf Kompilierungsfehler Beispiel: Allgemein – bezieht sich auf generische Fehler
data	object	Ein Wörterbuch, das Details zum Problem enthält.
message	string	Eine Beschreibung des Problems.
type	IssueType	Der Typ (Fehler, Warnung) des Problems.

IssueType

Der Typ (Fehler, Warnung) des Problems.

Name	Typ	Beschreibung
error	string
warning	string

JObject

Stellt ein JSON-Objekt dar.

Name	Typ	Beschreibung
item	string
type	string	Ruft den Knotentyp für dieses JToken ab.

TaskLogReference

Ein Verweis auf ein Aufgabenprotokoll. Diese Klasse enthält Informationen zu der Ausgabe, die während der Pipelineausführung in der Protokollkonsole des Zeitleiste Datensatzes ausgegeben wird.

Name	Typ	Beschreibung
id	integer	Die ID des Aufgabenprotokolls.
location	string	Die REST-URL des Aufgabenprotokolls.

TaskReference

Ein Verweis auf eine Aufgabe.

Name	Typ	Beschreibung
id	string	Die ID der Aufgabendefinition. Entspricht dem ID-Wert der Datei task.json. Beispiel: CmdLineV2 { "id": "D9BAFED4-0B18-4F58-968D-86655B4D2CE9" }
inputs	object	Ein Wörterbuch mit Eingaben, die für eine Aufgabendefinition spezifisch sind. Entspricht dem Eingabewert der Datei task.json.
name	string	Der Name der Aufgabendefinition. Entspricht dem Namenswert der Datei task.json. Beispiel: CmdLineV2 { "name": "CmdLine" }
version	string	Die Version der Aufgabendefinition. Entspricht dem Versionswert der Datei task.json. Beispiel: CmdLineV2 { "version": { "Major": 2, "Minor": 212, "Patch": 0 } }

TaskResult

Name	Typ	Beschreibung
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string

TimelineAttempt

Ein Versuch, einen Zeitachsendatensatz zu aktualisieren.

Name	Typ	Beschreibung
attempt	integer	Der Versuch des Datensatzes.
identifier	string	Der eindeutige Bezeichner für den Datensatz
recordId	string	Der Datensatzbezeichner innerhalb der angegebenen Zeitleiste.
timelineId	string	Der Zeitleiste Bezeichner, dem der Datensatz gehört, der diesen Versuch darstellt.

TimelineRecord

Ausführliche Informationen zur Ausführung verschiedener Vorgänge während der Pipelineausführung.

Name	Typ	Beschreibung
agentSpecification	JObject	Die Spezifikation eines Agents, der einen Pipelineauftrag im Binärformat ausführt. Anwendbar, wenn der Datensatz vom Typ "Auftrag" ist. Beispiel: { "VMImage" : "windows-2019" }
attempt	integer	Die Anzahl der Datensatzversuche.
changeId	integer	Die ID, die alle Datensätze verbindet, die gleichzeitig aktualisiert wurden. Dieser Wert stammt aus Zeitleiste ChangeId.
currentOperation	string	Eine Zeichenfolge, die den aktuellen Vorgang angibt.
details	TimelineReference	Ein Verweis auf einen untergeordneten Zeitleiste.
errorCount	integer	Die Anzahl der Fehler, die von diesem Vorgang erzeugt werden.
finishTime	string	Die Endzeit des Datensatzes.
id	string	Die ID des Datensatzes.
identifier	string	Zeichenfolgenbezeichner, der bei allen Versuchen konsistent ist.
issues	Issue[]	Die Liste der von diesem Vorgang erzeugten Probleme.
lastModified	string	Der Zeitpunkt der letzten Änderung des Datensatzes.
location	string	Die REST-URL des Datensatzes.
log	TaskLogReference	Ein Verweis auf das Protokoll, das von diesem Vorgang erstellt wird.
name	string	Der Name des Datensatzes.
order	integer	Ein Ordnungswert relativ zu anderen Datensätzen innerhalb des Zeitleiste.
parentId	string	Die ID des übergeordneten Datensatzes. Beispiel: Phase ist ein übergeordnetes Element einer Phase, Phase ist ein übergeordnetes Element eines Auftrags, Auftrag ist ein übergeordnetes Element einer Aufgabe.
percentComplete	integer	Der Prozentsatz des Datensatzabschlusses.
previousAttempts	TimelineAttempt[]	Die vorherigen Datensatzversuche.
queueId	integer	Die ID der Warteschlange, die Projekte mit Agentpools verbindet, in denen der Vorgang ausgeführt wurde. Anwendbar, wenn der Datensatz vom Typ "Auftrag" ist.
refName	string	Name des Datensatzes, auf den verwiesen wird.
result	TaskResult	Das Ergebnis des Datensatzes.
resultCode	string	Auswertung vordefinierter Bedingungen nach Abschluss des Datensatzvorgangs. Beispiel: Auswerten von `succeeded()`, Ergebnis = True Beispiel: Auswerten von `and(succeeded(), eq(variables['system.debug'], False))`, Ergebnis = False
startTime	string	Die Startzeit des Datensatzes.
state	TimelineRecordState	Der Status des Datensatzes.
task	TaskReference	Ein Verweis auf die Aufgabe. Anwendbar, wenn der Datensatz vom Typ Task ist.
type	string	Der Typ des Vorgangs, der vom Datensatz nachverfolgt wird. Beispiel: Stage, Phase, Job, Task...
variables	<string, VariableValue>	Die Variablen des Datensatzes.
warningCount	integer	Die Anzahl der Warnungen, die von diesem Vorgang erzeugt werden.
workerName	string	Der Name des Agents, der den Vorgang ausführt. Anwendbar, wenn der Datensatz vom Typ "Auftrag" ist.

TimelineRecordState

Der Status des Datensatzes.

Name	Typ	Beschreibung
completed	string
inProgress	string
pending	string

TimelineReference

Ein Verweis auf eine Zeitleiste.

Name	Typ	Beschreibung
changeId	integer	Die Änderungs-ID.
id	string	Die ID des Zeitleiste.
location	string	Die REST-URL des Zeitleiste.

VariableValue

Eine Wrapperklasse für eine generische Variable.

Name	Typ	Beschreibung
isReadOnly	boolean	Gibt an, ob die Variable während der Ausführungslaufzeit des Skripts geändert werden kann.
isSecret	boolean	Gibt an, ob die Variable im Ruhezustand verschlüsselt werden soll.
value	string	Der Wert der Variablen.

VssJsonCollectionWrapper

Diese Klasse wird verwendet, um Auflistungen als einzelnes JSON-Objekt im Wire zu serialisieren.

Name	Typ	Beschreibung
count	integer	Die Anzahl der serialisierten Elemente.
value	string	Das serialisierte Element.

Freigeben über