Records - Update

Referenz

Dienst:: Distributed Task

API-Version:: 7.1

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

PATCH https://dev.azure.com/{organization}/{scopeIdentifier}/_apis/distributedtask/hubs/{hubName}/plans/{planId}/timelines/{timelineId}/records?api-version=7.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 der Zeitachse.
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name	Typ	Beschreibung
count	integer (int32)	Die Anzahl serialisierter Elemente.
value	string (T)	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.

Typ: basic

Beispiele

Update timeline's records

Beispielanforderung

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
}

Beispiel für eine Antwort

Statuscode:: 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 zur Ausgabe, die während der Pipelineausführung in die Protokollkonsole des Zeitachsendatensatzes gedruckt wird.
TaskReference	Ein Verweis auf einen Vorgang.
TaskResult
TimelineAttempt	Ein Versuch, einen TimelineRecord zu aktualisieren.
TimelineRecord	Detaillierte Informationen zur Ausführung verschiedener Vorgänge während der Pipelineausführung.
TimelineRecordState	Der Status des Datensatzes.
TimelineReference	Ein Verweis auf eine Zeitachse.
VariableValue	Eine Wrapperklasse für eine generische Variable.
VssJsonCollectionWrapper	Diese Klasse wird verwendet, um Sammlungen als einzelnes JSON-Objekt in der Draht zu serialisieren.

Issue

Objekt

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 mit Details zum Problem.
message	string	Eine Beschreibung des Problems.
type	IssueType	Der Typ (Fehler, Warnung) des Problems.

IssueType

Enumeration

Der Typ (Fehler, Warnung) des Problems.

Wert	Beschreibung
error
warning

JObject

Objekt

Stellt ein JSON-Objekt dar.

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

TaskLogReference

Objekt

Ein Verweis auf ein Aufgabenprotokoll. Diese Klasse enthält Informationen zur Ausgabe, die während der Pipelineausführung in die Protokollkonsole des Zeitachsendatensatzes gedruckt wird.

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

TaskReference

Objekt

Ein Verweis auf einen Vorgang.

Name	Typ	Beschreibung
id	string (uuid)	Die ID der Vorgangsdefinition. Entspricht dem ID-Wert task.json Datei. 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 task.json Datei.
name	string	Der Name der Aufgabendefinition. Entspricht dem Namenswert task.json Datei. Beispiel: CmdLineV2 { "name": "CmdLine" }
version	string	Die Version der Aufgabendefinition. Entspricht dem Versionswert task.json Datei. Beispiel: CmdLineV2 { "version": { "Major": 2, "Minor": 212, "Patch": 0 } }

TaskResult

Enumeration

Wert	Beschreibung
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues

TimelineAttempt

Objekt

Ein Versuch, einen TimelineRecord zu aktualisieren.

Name	Typ	Beschreibung
attempt	integer (int32)	Der Versuch des Datensatzes.
identifier	string	Der eindeutige Bezeichner für den Datensatz.
recordId	string (uuid)	Der Datensatzbezeichner, der sich innerhalb der angegebenen Zeitachse befindet.
timelineId	string (uuid)	Der Zeitachsenbezeichner, der den Datensatz besitzt, der diesen Versuch darstellt.

TimelineRecord

Objekt

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

Name	Typ	Beschreibung
agentSpecification	JObject	Die Spezifikation eines Agents, der einen Pipelineauftrag ausführt, im Binärformat. Gilt, wenn der Datensatz vom Typ "Auftrag" ist. Beispiel: { "VMImage" : "windows-2019" }
attempt	integer (int32)	Die Anzahl der Datensatzversuche.
changeId	integer (int32)	Die ID, die alle Gleichzeitig aktualisierten Datensätze verbindet. Dieser Wert stammt aus der ChangeId der Zeitachse.
currentOperation	string	Eine Zeichenfolge, die den aktuellen Vorgang angibt.
details	TimelineReference	Ein Verweis auf eine Unterzeitachse.
errorCount	integer (int32)	Die Anzahl der von diesem Vorgang erzeugten Fehler.
finishTime	string (date-time)	Die Endzeit des Datensatzes.
id	string (uuid)	Die ID des Datensatzes.
identifier	string	Zeichenfolgenbezeichner, der über Versuche hinweg konsistent ist.
issues	Issue[]	Die Liste der probleme, die von diesem Vorgang erstellt wurden.
lastModified	string (date-time)	Der Zeitpunkt, zu dem der Datensatz zuletzt geändert wurde.
location	string	Die REST-URL des Datensatzes.
log	TaskLogReference	Ein Verweis auf das von diesem Vorgang erstellte Protokoll.
name	string	Der Name des Datensatzes.
order	integer (int32)	Ein Ordinalwert relativ zu anderen Datensätzen innerhalb der Zeitachse.
parentId	string (uuid)	Die ID des übergeordneten Datensatzes. Beispiel: Phase ist ein übergeordnetes Element einer Phase, Phase ist ein übergeordnetes Element eines Auftrags, Job ist ein übergeordnetes Element einer Aufgabe.
percentComplete	integer (int32)	Der Prozentsatz des Abschlusses des Datensatzes.
previousAttempts	TimelineAttempt[]	Der vorherige Datensatz versucht.
queueId	integer (int32)	Die ID der Warteschlange, die Projekte mit Agentpools verbindet, auf denen der Vorgang ausgeführt wurde. Gilt, 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()`, Result = True Beispiel: Auswerten von `and(succeeded(), eq(variables['system.debug'], False))`, Ergebnis = False
startTime	string (date-time)	Die Startzeit des Datensatzes.
state	TimelineRecordState	Der Status des Datensatzes.
task	TaskReference	Ein Verweis auf den Vorgang. Gültig, wenn der Datensatz vom Typ "Aufgabe" ist.
type	string	Der Typ des Vorgangs, der vom Datensatz nachverfolgt wird. Beispiel: Phase, Phase, Auftrag, Aufgabe...
variables	<string, VariableValue>	Die Variablen des Datensatzes.
warningCount	integer (int32)	Die Anzahl der Warnungen, die von diesem Vorgang erzeugt werden.
workerName	string	Der Name des Agents, der den Vorgang ausführt. Gilt, wenn der Datensatz vom Typ "Auftrag" ist.

TimelineRecordState

Enumeration

Der Status des Datensatzes.

Wert	Beschreibung
completed
inProgress
pending

TimelineReference

Objekt

Ein Verweis auf eine Zeitachse.

Name	Typ	Beschreibung
changeId	integer (int32)	Die Änderungs-ID.
id	string (uuid)	Die ID der Zeitachse.
location	string	Die REST-URL der Zeitachse.

VariableValue

Objekt

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

Objekt

Diese Klasse wird verwendet, um Sammlungen als einzelnes JSON-Objekt in der Draht zu serialisieren.

Name	Typ	Beschreibung
count	integer (int32)	Die Anzahl serialisierter Elemente.
value	string (T)	Das serialisierte Element.

Freigeben über

Records - Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

accessToken

Beispiele

Update timeline's records

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Issue

IssueType

JObject

TaskLogReference

TaskReference

TaskResult

TimelineAttempt

TimelineRecord

TimelineRecordState

TimelineReference

VariableValue

VssJsonCollectionWrapper