Records - Update

Başvuru

Hizmet:: Distributed Task

API Sürümü:: 7.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

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ı daraltmak için 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' olarak ayarlanmalıdır.

İstek Gövdesi

Name	Tür	Description
count	integer (int32)	Serileştirilmiş öğelerin sayısı.
value	string (T)	Serileştirilmiş öğ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.

Tür: basic

Örnekler

Update timeline's records

Örnek isteği

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
}

Örnek yanıt

Durum kodu:: 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	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

Object

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

Name	Tür	Description
category	string	Sorunun kategorisi. Örnek: Kod - derleme hatalarını ifade eder Ö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

Listeleme

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

Değer	Description
error
warning

JObject

Object

JSON nesnesini temsil eder.

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

TaskLogReference

Object

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 (int32)	Görev günlüğünün kimliği.
location	string	Görev günlüğünün REST URL'si.

TaskReference

Object

Göreve başvuru.

Name	Tür	Description
id	string (uuid)	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 giriş 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

Listeleme

Değer	Description
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues

TimelineAttempt

Object

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

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

TimelineRecord

Object

İş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ı belirtimi. Kayıt İş türünde olduğunda geçerlidir. Örnek: { "VMImage" : "windows-2019" }
attempt	integer (int32)	Kayıt denemelerinin sayısı.
changeId	integer (int32)	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	Bir alt zaman çizelgesine başvuru.
errorCount	integer (int32)	Bu işlem tarafından oluşturulan hata sayısı.
finishTime	string (date-time)	Kaydın bitiş zamanı.
id	string (uuid)	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 (date-time)	Kaydın son değiştirildiği saat.
location	string	Kaydın REST URL'si.
log	TaskLogReference	Bu işlem tarafından oluşturulan günlüğe başvuru.
name	string	Kaydın adı.
order	integer (int32)	Zaman çizelgesindeki diğer kayıtlara göre sıralı bir değer.
parentId	string (uuid)	Kaydın üst öğesinin kimliği. Örnek: Aşama bir Aşamanın üst öğesidir, Aşama bir İşin üst öğesidir, İş bir Görevin üst öğesidir.
percentComplete	integer (int32)	Kayıt tamamlanma yüzdesi.
previousAttempts	TimelineAttempt[]	Önceki kayıt denemeleri.
queueId	integer (int32)	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: `succeeded()`Değerlendirme , Sonuç = Doğru Örnek: `and(succeeded(), eq(variables['system.debug'], False))`Değerlendirme , Sonuç = Yanlış
startTime	string (date-time)	Kaydın başlangıç saati.
state	TimelineRecordState	Kaydın durumu.
task	TaskReference	Göreve 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 (int32)	Bu işlem tarafından oluşturulan uyarı sayısı.
workerName	string	İşlemi çalıştıran aracının adı. Kayıt İş türünde olduğunda geçerlidir.

TimelineRecordState

Listeleme

Kaydın durumu.

Değer	Description
completed
inProgress
pending

TimelineReference

Object

Zaman çizelgesine başvuru.

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

VariableValue

Object

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

Object

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 (int32)	Serileştirilmiş öğelerin sayısı.
value	string (T)	Serileştirilmiş öğe.

Aracılığıyla paylaş

Records - Update

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

accessToken

Örnekler

Update timeline's records

Örnek isteği

Örnek yanıt

Tanımlar

Issue

IssueType

JObject

TaskLogReference

TaskReference

TaskResult

TimelineAttempt

TimelineRecord

TimelineRecordState

TimelineReference

VariableValue

VssJsonCollectionWrapper