Records - Update

Odwołanie

Service:: Distributed Task

API Version:: 7.1-preview.1

Zaktualizuj rekordy osi czasu, jeśli już istnieją, w przeciwnym razie utwórz nowe dla tej samej osi czasu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
hubName	path	True	string	Nazwa centrum serwera. Typowe przykłady: "build", "rm", "checks"
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
planId	path	True	string uuid	Identyfikator planu.
scopeIdentifier	path	True	string uuid	Identyfikator GUID projektu w celu określenia zakresu żądania
timelineId	path	True	string uuid	Identyfikator osi czasu.
api-version	query	True	string	Wersja interfejsu API do użycia. Ta wartość powinna być ustawiona na wartość "7.1-preview.1", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
count	integer	Liczba serializowanych elementów.
value	string	Serializowany element.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	TimelineRecord[]	operacja zakończona powodzeniem

Zabezpieczenia

accessToken

Osobisty token dostępu. Użyj dowolnej wartości nazwy użytkownika i tokenu jako hasła.

Type: basic

Przykłady

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
    }
  ]
}

Definicje

Nazwa	Opis
Issue	Problem (błąd, ostrzeżenie) skojarzony z uruchomieniem potoku.
IssueType	Typ (błąd, ostrzeżenie) problemu.
JObject	Reprezentuje obiekt JSON.
TaskLogReference	Odwołanie do dziennika zadań. Ta klasa zawiera informacje o danych wyjściowych drukowanych w konsoli dzienników rekordu osi czasu podczas uruchamiania potoku.
TaskReference	Odwołanie do zadania.
TaskResult
TimelineAttempt	Próba zaktualizowania elementu TimelineRecord.
TimelineRecord	Szczegółowe informacje o wykonywaniu różnych operacji podczas uruchamiania potoku.
TimelineRecordState	Stan rekordu.
TimelineReference	Odwołanie do osi czasu.
VariableValue	Klasa otoki dla zmiennej ogólnej.
VssJsonCollectionWrapper	Ta klasa służy do serializacji kolekcji jako pojedynczego obiektu JSON w sieci.

Issue

Problem (błąd, ostrzeżenie) skojarzony z uruchomieniem potoku.

Nazwa	Typ	Opis
category	string	Kategoria problemu. Przykład: Kod — odnosi się do błędów kompilacji Przykład: Ogólne — odnosi się do błędów ogólnych
data	object	Słownik zawierający szczegółowe informacje o problemie.
message	string	Opis problemu.
type	IssueType	Typ (błąd, ostrzeżenie) problemu.

IssueType

Typ (błąd, ostrzeżenie) problemu.

Nazwa	Typ	Opis
error	string
warning	string

JObject

Reprezentuje obiekt JSON.

Nazwa	Typ	Opis
item	string
type	string	Pobiera typ węzła dla tego tokenu JToken.

TaskLogReference

Odwołanie do dziennika zadań. Ta klasa zawiera informacje o danych wyjściowych drukowanych w konsoli dzienników rekordu osi czasu podczas uruchamiania potoku.

Nazwa	Typ	Opis
id	integer	Identyfikator dziennika zadań.
location	string	Adres URL REST dziennika zadań.

TaskReference

Odwołanie do zadania.

Nazwa	Typ	Opis
id	string	Identyfikator definicji zadania. Odpowiada wartości id pliku task.json. Przykład: CmdLineV2 { "id": "D9BAFED4-0B18-4F58-968D-86655B4D2CE9" }
inputs	object	Słownik danych wejściowych specyficznych dla definicji zadania. Odpowiada wartości wejściowej pliku task.json.
name	string	Nazwa definicji zadania. Odpowiada wartości nazwy pliku task.json. Przykład: CmdLineV2 { "name": "CmdLine" }
version	string	Wersja definicji zadania. Odpowiada wartości wersji pliku task.json. Przykład: CmdLineV2 { "version": { "Major": 2, "Minor": 212, "Patch": 0 } }

TaskResult

Nazwa	Typ	Opis
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string

TimelineAttempt

Próba zaktualizowania elementu TimelineRecord.

Nazwa	Typ	Opis
attempt	integer	Próba rekordu.
identifier	string	Unikatowy identyfikator rekordu.
recordId	string	Identyfikator rekordu znajdujący się na określonej osi czasu.
timelineId	string	Identyfikator osi czasu, który jest właścicielem rekordu reprezentującego tę próbę.

TimelineRecord

Szczegółowe informacje o wykonywaniu różnych operacji podczas uruchamiania potoku.

Nazwa	Typ	Opis
agentSpecification	JObject	Specyfikacja agenta uruchamiającego zadanie potoku w formacie binarnym. Dotyczy, gdy rekord jest typu Zadanie. Przykład: { "VMImage": "windows-2019" }
attempt	integer	Liczba prób rekordu.
changeId	integer	Identyfikator łączący wszystkie rekordy zaktualizowane w tym samym czasie. Ta wartość jest pobierana z identyfikatora ChangeId osi czasu.
currentOperation	string	Ciąg wskazujący bieżącą operację.
details	TimelineReference	Odwołanie do pod osi czasu.
errorCount	integer	Liczba błędów generowanych przez tę operację.
finishTime	string	Godzina zakończenia rekordu.
id	string	Identyfikator rekordu.
identifier	string	Identyfikator ciągu, który jest spójny w wielu próbach.
issues	Issue[]	Lista problemów generowanych przez tę operację.
lastModified	string	Czas ostatniej modyfikacji rekordu.
location	string	Adres URL REST rekordu.
log	TaskLogReference	Odwołanie do dziennika utworzonego przez tę operację.
name	string	Nazwa rekordu.
order	integer	Wartość porządkowa względem innych rekordów na osi czasu.
parentId	string	Identyfikator elementu nadrzędnego rekordu. Przykład: Etap jest elementem nadrzędnym fazy, Faza jest elementem nadrzędnym zadania, zadanie jest elementem nadrzędnym zadania.
percentComplete	integer	Procent ukończenia rekordu.
previousAttempts	TimelineAttempt[]	Poprzednie próby rekordu.
queueId	integer	Identyfikator kolejki, która łączy projekty z pulami agentów, na których uruchomiono operację. Dotyczy, gdy rekord jest typu Zadanie.
refName	string	Nazwa rekordu, do których odwołuje się odwołanie.
result	TaskResult	Wynik rekordu.
resultCode	string	Ocena wstępnie zdefiniowanych warunków po zakończeniu operacji rekordu. Przykład: Obliczanie `succeeded()`, Wynik = True Przykład: Ocena `and(succeeded(), eq(variables['system.debug'], False))`, Wynik = Fałsz
startTime	string	Godzina rozpoczęcia rekordu.
state	TimelineRecordState	Stan rekordu.
task	TaskReference	Odwołanie do zadania. Dotyczy, gdy rekord jest typu Zadanie.
type	string	Typ operacji śledzonej przez rekord. Przykład: Etap, Faza, Zadanie, Zadanie...
variables	<string, VariableValue>	Zmienne rekordu.
warningCount	integer	Liczba ostrzeżeń generowanych przez tę operację.
workerName	string	Nazwa agenta, na którym uruchomiono operację. Dotyczy, gdy rekord jest typu Zadanie.

TimelineRecordState

Stan rekordu.

Nazwa	Typ	Opis
completed	string
inProgress	string
pending	string

TimelineReference

Odwołanie do osi czasu.

Nazwa	Typ	Opis
changeId	integer	Identyfikator zmiany.
id	string	Identyfikator osi czasu.
location	string	Adres URL REST osi czasu.

VariableValue

Klasa otoki dla zmiennej ogólnej.

Nazwa	Typ	Opis
isReadOnly	boolean	Wskazuje, czy zmienną można zmienić podczas wykonywania skryptu.
isSecret	boolean	Wskazuje, czy zmienna powinna być szyfrowana w spoczynku.
value	string	Wartość zmiennej.

VssJsonCollectionWrapper

Ta klasa służy do serializacji kolekcji jako pojedynczego obiektu JSON w sieci.

Nazwa	Typ	Opis
count	integer	Liczba serializowanych elementów.
value	string	Serializowany element.

Udostępnij za pośrednictwem