Records - Update

Başvuru

Service:: Distributed Task

API Version:: 7.1-preview.1

Zaten varsa zaman çizelgesi kayıtlarını güncelleştirin, aksi takdirde aynı zaman çizelgesi için yenilerini oluşturun.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
hubName	path	True	string	Sunucu hub'ının adı. Yaygın örnekler: "build", "rm", "checks"
organization	path	True	string	Azure DevOps kuruluşunun adı.
planId	path	True	string uuid	Planın kimliği.
scopeIdentifier	path	True	string uuid	İsteğin kapsamını gösteren proje GUID'i
timelineId	path	True	string uuid	Zaman çizelgesinin kimliği.
api-version	query	True	string	Kullanılacak API'nin sürümü. Bu, api'nin bu sürümünü kullanmak için '7.1-preview.1' olarak ayarlanmalıdır.

İstek Gövdesi

Name	Tür	Description
count	integer	Serileştirilmiş öğelerin sayısı.
value	string	Seri hale getirilmiş öğe.

Yanıtlar

Name	Tür	Description
200 OK	TimelineRecord[]	başarılı işlem

Güvenlik

accessToken

Kişisel erişim belirteci. Parola olarak kullanıcı adı ve belirteç için herhangi bir değer kullanın.

Type: basic

Örnekler

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

Tanımlar

Name	Description
Issue	İşlem hattı çalıştırmasıyla ilişkili bir sorun (hata, uyarı).
IssueType	Sorunun türü (hata, uyarı).
JObject	Bir JSON nesnesini temsil eder.
TaskLogReference	Görev günlüğüne başvuru. Bu sınıf, işlem hattı çalıştırması sırasında zaman çizelgesi kaydının günlük konsoluna yazdırılan çıktı hakkında bilgi içerir.
TaskReference	Göreve başvuru.
TaskResult
TimelineAttempt	Zaman ÇizelgesiKayıt'ı güncelleştirme girişimi.
TimelineRecord	İşlem hattı çalıştırması sırasında farklı işlemlerin yürütülmesi hakkında ayrıntılı bilgi.
TimelineRecordState	Kaydın durumu.
TimelineReference	Zaman çizelgesine başvuru.
VariableValue	Genel değişken için sarmalayıcı sınıfı.
VssJsonCollectionWrapper	Bu sınıf, koleksiyonları tel üzerinde tek bir JSON nesnesi olarak serileştirmek için kullanılır.

Issue

İşlem hattı çalıştırmasıyla ilişkili bir sorun (hata, uyarı).

Name	Tür	Description
category	string	Sorunun kategorisi. Örnek: Kod - derleme hatalarına başvurur Örnek: Genel - genel hataları ifade eder
data	object	Sorunla ilgili ayrıntıları içeren bir sözlük.
message	string	Sorunun açıklaması.
type	IssueType	Sorunun türü (hata, uyarı).

IssueType

Sorunun türü (hata, uyarı).

Name	Tür	Description
error	string
warning	string

JObject

Bir JSON nesnesini temsil eder.

Name	Tür	Description
item	string
type	string	Bu JToken için düğüm türünü alır.

TaskLogReference

Görev günlüğüne başvuru. Bu sınıf, işlem hattı çalıştırması sırasında zaman çizelgesi kaydının günlük konsoluna yazdırılan çıktı hakkında bilgi içerir.

Name	Tür	Description
id	integer	Görev günlüğünün kimliği.
location	string	Görev günlüğünün REST URL'si.

TaskReference

Göreve başvuru.

Name	Tür	Description
id	string	Görev tanımının kimliği. task.json dosyasının kimlik değerine karşılık gelir. Örnek: CmdLineV2 { "id": "D9BAFED4-0B18-4F58-968D-86655B4D2CE9" }
inputs	object	Görev tanımına özgü girişlerin sözlüğü. task.json dosyasının inputs değerine karşılık gelir.
name	string	Görev tanımının adı. task.json dosyasının ad değerine karşılık gelir. Örnek: CmdLineV2 { "name": "CmdLine" }
version	string	Görev tanımının sürümü. task.json dosyasının sürüm değerine karşılık gelir. Örnek: CmdLineV2 { "version": { "Major": 2, "Minor": 212, "Patch": 0 } }

TaskResult

Name	Tür	Description
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string

TimelineAttempt

Zaman ÇizelgesiKayıt'ı güncelleştirme girişimi.

Name	Tür	Description
attempt	integer	Kaydın girişimi.
identifier	string	Kaydın benzersiz tanımlayıcısı.
recordId	string	Belirtilen zaman çizelgesinde bulunan kayıt tanımlayıcısı.
timelineId	string	Bu girişimi temsil eden kaydın sahibi olan zaman çizelgesi tanımlayıcısı.

TimelineRecord

İşlem hattı çalıştırması sırasında farklı işlemlerin yürütülmesi hakkında ayrıntılı bilgi.

Name	Tür	Description
agentSpecification	JObject	İkili biçimde bir işlem hattı işi çalıştıran bir aracının belirtimi. Kayıt İş türünde olduğunda geçerlidir. Örnek: { "VMImage" : "windows-2019" }
attempt	integer	Kayıt denemelerinin sayısı.
changeId	integer	Tüm kayıtları bağlayan kimlik aynı anda güncelleştirildi. Bu değer zaman çizelgesinin ChangeId değerinden alınır.
currentOperation	string	Geçerli işlemi gösteren bir dize.
details	TimelineReference	Alt zaman çizelgesine başvuru.
errorCount	integer	Bu işlem tarafından oluşturulan hata sayısı.
finishTime	string	Kaydın bitiş zamanı.
id	string	Kaydın kimliği.
identifier	string	Girişimler arasında tutarlı olan dize tanımlayıcısı.
issues	Issue[]	Bu işlem tarafından oluşturulan sorunların listesi.
lastModified	string	Kaydın son değiştirilme zamanı.
location	string	Kaydın REST URL'si.
log	TaskLogReference	Bu işlem tarafından üretilen günlüğe başvuru.
name	string	Kaydın adı.
order	integer	Zaman çizelgesindeki diğer kayıtlara göre sıra değeri.
parentId	string	Kaydın üst öğesinin kimliği. Örnek: Aşama bir Aşamanın üst öğesi, Aşama bir İşin üst öğesi, İş bir Görevin üst öğesidir.
percentComplete	integer	Kaydın tamamlanma yüzdesi.
previousAttempts	TimelineAttempt[]	Önceki kayıt denemeleri.
queueId	integer	Projeleri işlemin üzerinde çalıştırıldığı aracı havuzlarına bağlayan kuyruğun kimliği. Kayıt İş türünde olduğunda geçerlidir.
refName	string	Başvuruda bulunan kaydın adı.
result	TaskResult	Kaydın sonucu.
resultCode	string	Kaydın işlemi tamamlandıktan sonra önceden tanımlanmış koşulların değerlendirilmesi. Örnek: Değerlendirme `succeeded()`, Sonuç = Doğru Örnek: Değerlendirme `and(succeeded(), eq(variables['system.debug'], False))`, Sonuç = Yanlış
startTime	string	Kaydın başlangıç saati.
state	TimelineRecordState	Kaydın durumu.
task	TaskReference	Göreve bir başvuru. Kayıt Görev türünde olduğunda geçerlidir.
type	string	Kayıt tarafından izlenen işlemin türü. Örnek: Aşama, Aşama, İş, Görev...
variables	<string, VariableValue>	Kaydın değişkenleri.
warningCount	integer	Bu işlem tarafından üretilen uyarı sayısı.
workerName	string	İşlemi çalıştıran aracının adı. Kayıt İş türünde olduğunda geçerlidir.

TimelineRecordState

Kaydın durumu.

Name	Tür	Description
completed	string
inProgress	string
pending	string

TimelineReference

Zaman çizelgesine başvuru.

Name	Tür	Description
changeId	integer	Değişiklik kimliği.
id	string	Zaman çizelgesinin kimliği.
location	string	Zaman çizelgesinin REST URL'si.

VariableValue

Genel değişken için sarmalayıcı sınıfı.

Name	Tür	Description
isReadOnly	boolean	Değişkenin betiğin yürütme çalışma zamanı sırasında değiştirilip değiştirilemeyeceğini gösterir.
isSecret	boolean	Değişkenin bekleme sırasında şifrelenip şifrelenmemesi gerektiğini gösterir.
value	string	Değişkenin değeri.

VssJsonCollectionWrapper

Bu sınıf, koleksiyonları tel üzerinde tek bir JSON nesnesi olarak serileştirmek için kullanılır.

Name	Tür	Description
count	integer	Serileştirilmiş öğelerin sayısı.
value	string	Seri hale getirilmiş öğe.