Records - Update

Referensi

Layanan:: Distributed Task

Versi API:: 7.1

Perbarui rekaman garis waktu jika sudah ada, jika tidak, buat rekaman baru untuk garis waktu yang sama.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
hubName	path	True	string	Nama hub server. Contoh umum: "build", "rm", "checks"
organization	path	True	string	Nama organisasi Azure DevOps.
planId	path	True	string (uuid)	ID paket.
scopeIdentifier	path	True	string (uuid)	GUID proyek untuk mencakup permintaan
timelineId	path	True	string (uuid)	ID garis waktu.
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '7.1' untuk menggunakan versi api ini.

Isi Permintaan

Nama	Jenis	Deskripsi
count	integer (int32)	Jumlah item berseri.
value	string (T)	Item yang diserialisasikan.

Respons

Nama	Jenis	Deskripsi
200 OK	TimelineRecord[]	operasi berhasil

Keamanan

accessToken

Token akses pribadi. Gunakan nilai apa pun untuk nama pengguna dan token sebagai kata sandi.

Jenis: basic

Contoh

Update timeline's records

Permintaan sampel

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
}

Respon sampel

Kode status:: 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
    }
  ]
}

Definisi

Nama	Deskripsi
Issue	Masalah (kesalahan, peringatan) yang terkait dengan eksekusi alur.
IssueType	Jenis (kesalahan, peringatan) masalah.
JObject	Mewakili objek JSON.
TaskLogReference	Referensi ke log tugas. Kelas ini berisi informasi tentang output yang dicetak ke konsol log rekaman garis waktu selama eksekusi alur.
TaskReference	Referensi ke tugas.
TaskResult
TimelineAttempt	Upaya untuk memperbarui TimelineRecord.
TimelineRecord	Informasi terperinci tentang eksekusi operasi yang berbeda selama eksekusi alur.
TimelineRecordState	Status catatan.
TimelineReference	Referensi ke garis waktu.
VariableValue	Kelas pembungkus untuk variabel generik.
VssJsonCollectionWrapper	Kelas ini digunakan untuk menserialisasikan koleksi sebagai objek JSON tunggal pada kawat.

Issue

Objek

Masalah (kesalahan, peringatan) yang terkait dengan eksekusi alur.

Nama	Jenis	Deskripsi
category	string	Kategori masalah. Contoh: Kode - mengacu pada kesalahan kompilasi Contoh: Umum - mengacu pada kesalahan umum
data	object	Kamus yang berisi detail tentang masalah tersebut.
message	string	Deskripsi masalah.
type	IssueType	Jenis (kesalahan, peringatan) masalah.

IssueType

Enumeration

Jenis (kesalahan, peringatan) masalah.

Nilai	Deskripsi
error
warning

JObject

Objek

Mewakili objek JSON.

Nama	Jenis	Deskripsi
item	string (JToken)
type	string (JTokenType)	Mendapatkan jenis node untuk JToken ini.

TaskLogReference

Objek

Referensi ke log tugas. Kelas ini berisi informasi tentang output yang dicetak ke konsol log rekaman garis waktu selama eksekusi alur.

Nama	Jenis	Deskripsi
id	integer (int32)	ID log tugas.
location	string	URL REST log tugas.

TaskReference

Objek

Referensi ke tugas.

Nama	Jenis	Deskripsi
id	string (uuid)	ID definisi tugas. Sesuai dengan nilai id file task.json. Contoh: CmdLineV2 { "id": "D9BAFED4-0B18-4F58-968D-86655B4D2CE9" }
inputs	object	Kamus input khusus untuk definisi tugas. Sesuai dengan nilai input file task.json.
name	string	Nama definisi tugas. Sesuai dengan nilai nama file task.json. Contoh: CmdLineV2 { "name": "CmdLine" }
version	string	Versi definisi tugas. Sesuai dengan nilai versi file task.json. Contoh: CmdLineV2 { "version": { "Major": 2, "Minor": 212, "Patch": 0 } }

TaskResult

Enumeration

Nilai	Deskripsi
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues

TimelineAttempt

Objek

Upaya untuk memperbarui TimelineRecord.

Nama	Jenis	Deskripsi
attempt	integer (int32)	Upaya rekaman.
identifier	string	Pengidentifikasi unik untuk rekaman.
recordId	string (uuid)	Pengidentifikasi rekaman yang terletak dalam garis waktu yang ditentukan.
timelineId	string (uuid)	Pengidentifikasi garis waktu yang memiliki rekaman yang mewakili upaya ini.

TimelineRecord

Objek

Informasi terperinci tentang eksekusi operasi yang berbeda selama eksekusi alur.

Nama	Jenis	Deskripsi
agentSpecification	JObject	Spesifikasi agen yang menjalankan pekerjaan alur, dalam format biner. Berlaku ketika rekaman berjenis Pekerjaan. Contoh: { "VMImage" : "windows-2019" }
attempt	integer (int32)	Jumlah upaya rekaman.
changeId	integer (int32)	ID yang menghubungkan semua rekaman diperbarui secara bersamaan. Nilai ini diambil dari ChangeId garis waktu.
currentOperation	string	String yang menunjukkan operasi saat ini.
details	TimelineReference	Referensi ke sub-garis waktu.
errorCount	integer (int32)	Jumlah kesalahan yang dihasilkan oleh operasi ini.
finishTime	string (date-time)	Waktu selesai rekaman.
id	string (uuid)	ID rekaman.
identifier	string	Pengidentifikasi string yang konsisten di seluruh upaya.
issues	Issue[]	Daftar masalah yang dihasilkan oleh operasi ini.
lastModified	string (date-time)	Waktu rekaman terakhir diubah.
location	string	URL REST rekaman.
log	TaskLogReference	Referensi ke log yang dihasilkan oleh operasi ini.
name	string	Nama rekaman.
order	integer (int32)	Nilai ordinal relatif terhadap rekaman lain dalam garis waktu.
parentId	string (uuid)	ID induk rekaman. Contoh: Tahap adalah induk dari Fase, Fase adalah induk pekerjaan, Pekerjaan adalah induk Tugas.
percentComplete	integer (int32)	Persentase penyelesaian rekaman.
previousAttempts	TimelineAttempt[]	Upaya rekaman sebelumnya.
queueId	integer (int32)	ID antrean yang menghubungkan proyek ke kumpulan agen tempat operasi dijalankan. Berlaku ketika rekaman berjenis Pekerjaan.
refName	string	Nama rekaman yang direferensikan.
result	TaskResult	Hasil rekaman.
resultCode	string	Evaluasi kondisi yang telah ditentukan sebelumnya setelah menyelesaikan operasi rekaman. Contoh: Mengevaluasi `succeeded()`, Hasil = True Contoh: Mengevaluasi `and(succeeded(), eq(variables['system.debug'], False))`, Hasil = False
startTime	string (date-time)	Waktu mulai rekaman.
state	TimelineRecordState	Status catatan.
task	TaskReference	Referensi ke tugas. Berlaku ketika rekaman berjenis Tugas.
type	string	Jenis operasi yang sedang dilacak oleh rekaman. Contoh: Tahap, Fase, Pekerjaan, Tugas...
variables	<string, VariableValue>	Variabel rekaman.
warningCount	integer (int32)	Jumlah peringatan yang dihasilkan oleh operasi ini.
workerName	string	Nama agen yang menjalankan operasi. Berlaku ketika rekaman berjenis Pekerjaan.

TimelineRecordState

Enumeration

Status catatan.

Nilai	Deskripsi
completed
inProgress
pending

TimelineReference

Objek

Referensi ke garis waktu.

Nama	Jenis	Deskripsi
changeId	integer (int32)	ID perubahan.
id	string (uuid)	ID garis waktu.
location	string	URL REST garis waktu.

VariableValue

Objek

Kelas pembungkus untuk variabel generik.

Nama	Jenis	Deskripsi
isReadOnly	boolean	Menunjukkan apakah variabel dapat diubah selama runtime eksekusi skrip.
isSecret	boolean	Menunjukkan apakah variabel harus dienkripsi saat tidak aktif.
value	string	Nilai variabel.

VssJsonCollectionWrapper

Objek

Kelas ini digunakan untuk menserialisasikan koleksi sebagai objek JSON tunggal pada kawat.

Nama	Jenis	Deskripsi
count	integer (int32)	Jumlah item berseri.
value	string (T)	Item yang diserialisasikan.