Records - Update

참조

Service:: Distributed Task

API Version:: 7.1-preview.1

타임라인 레코드가 이미 있는 경우 업데이트하고, 그렇지 않으면 동일한 타임라인 대한 새 레코드를 만듭니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
hubName	path	True	string	서버 허브의 이름입니다. 일반적인 예: "build", "rm", "checks"
organization	path	True	string	Azure DevOps 조직의 이름입니다.
planId	path	True	string uuid	계획의 ID입니다.
scopeIdentifier	path	True	string uuid	요청을 scope 프로젝트 GUID
timelineId	path	True	string uuid	타임라인 ID입니다.
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 api를 사용하려면 '7.1-preview.1'로 설정해야 합니다.

요청 본문

Name	형식	Description
count	integer	직렬화된 항목의 수입니다.
value	string	직렬화된 항목입니다.

응답

Name	형식	Description
200 OK	TimelineRecord[]	성공한 작업

보안

accessToken

개인용 액세스 토큰입니다. 사용자 이름 및 토큰에 대한 모든 값을 암호로 사용합니다.

Type: basic

예제

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

정의

Name	Description
Issue	파이프라인 실행과 관련된 문제(오류, 경고)
IssueType	문제의 유형(오류, 경고)입니다.
JObject	JSON 개체를 나타냅니다.
TaskLogReference	작업 로그에 대한 참조입니다. 이 클래스에는 파이프라인을 실행하는 동안 타임라인 레코드의 로그 콘솔에 출력되는 출력에 대한 정보가 포함되어 있습니다.
TaskReference	작업에 대한 참조입니다.
TaskResult
TimelineAttempt	TimelineRecord를 업데이트하려는 시도입니다.
TimelineRecord	파이프라인 실행 중 다른 작업의 실행에 대한 자세한 정보입니다.
TimelineRecordState	레코드의 상태입니다.
TimelineReference	타임라인 대한 참조입니다.
VariableValue	제네릭 변수에 대한 래퍼 클래스입니다.
VssJsonCollectionWrapper	이 클래스는 컬렉션을 와이어의 단일 JSON 개체로 직렬화하는 데 사용됩니다.

Issue

파이프라인 실행과 관련된 문제(오류, 경고)

Name	형식	Description
category	string	문제의 범주입니다. 예제: 코드 - 컴파일 오류를 참조합니다. 예: 일반 - 제네릭 오류를 참조합니다.
data	object	문제에 대한 세부 정보가 포함된 사전입니다.
message	string	문제에 대한 설명입니다.
type	IssueType	문제의 유형(오류, 경고)입니다.

IssueType

문제의 유형(오류, 경고)입니다.

Name	형식	Description
error	string
warning	string

JObject

JSON 개체를 나타냅니다.

Name	형식	Description
item	string
type	string	이 JToken의 노드 형식을 가져옵니다.

TaskLogReference

작업 로그에 대한 참조입니다. 이 클래스에는 파이프라인을 실행하는 동안 타임라인 레코드의 로그 콘솔에 출력되는 출력에 대한 정보가 포함되어 있습니다.

Name	형식	Description
id	integer	작업 로그의 ID입니다.
location	string	작업 로그의 REST URL입니다.

TaskReference

작업에 대한 참조입니다.

Name	형식	Description
id	string	작업 정의의 ID입니다. task.json 파일의 ID 값에 해당합니다. 예: CmdLineV2 { "id": "D9BAFED4-0B18-4F58-968D-86655B4D2CE9" }
inputs	object	작업 정의와 관련된 입력 사전입니다. task.json 파일의 입력 값에 해당합니다.
name	string	작업 정의의 이름입니다. task.json 파일의 이름 값에 해당합니다. 예: CmdLineV2 { "name": "CmdLine" }
version	string	작업 정의의 버전입니다. task.json 파일의 버전 값에 해당합니다. 예: CmdLineV2 { "version": { "Major": 2, "Minor": 212, "Patch": 0 } }

TaskResult

Name	형식	Description
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string

TimelineAttempt

TimelineRecord를 업데이트하려는 시도입니다.

Name	형식	Description
attempt	integer	레코드의 시도입니다.
identifier	string	레코드에 대한 고유 식별자입니다.
recordId	string	지정된 타임라인 내에 있는 레코드 식별자입니다.
timelineId	string	이 시도를 나타내는 레코드를 소유하는 타임라인 식별자입니다.

TimelineRecord

파이프라인 실행 중 다른 작업의 실행에 대한 자세한 정보입니다.

Name	형식	Description
agentSpecification	JObject	파이프라인 작업을 실행하는 에이전트의 사양(이진 형식)입니다. 레코드가 Job 형식인 경우에 적용됩니다. 예: { "VMImage" : "windows-2019" }
attempt	integer	레코드 시도 횟수입니다.
changeId	integer	동시에 업데이트된 모든 레코드를 연결하는 ID입니다. 이 값은 타임라인 ChangeId에서 가져옵니다.
currentOperation	string	현재 작업을 나타내는 문자열입니다.
details	TimelineReference	하위 타임라인 대한 참조입니다.
errorCount	integer	이 작업에서 생성된 오류 수입니다.
finishTime	string	레코드의 완료 시간입니다.
id	string	레코드의 ID입니다.
identifier	string	여러 시도에서 일관된 문자열 식별자입니다.
issues	Issue[]	이 작업에서 생성된 문제 목록입니다.
lastModified	string	레코드가 마지막으로 수정된 시간입니다.
location	string	레코드의 REST URL입니다.
log	TaskLogReference	이 작업에서 생성된 로그에 대한 참조입니다.
name	string	레코드 이름입니다.
order	integer	타임라인 내의 다른 레코드를 기준으로 하는 서수 값입니다.
parentId	string	레코드의 부모 ID입니다. 예: Stage는 단계의 부모이고, 단계는 작업의 부모이고, 작업은 작업의 부모입니다.
percentComplete	integer	레코드 완성의 백분율입니다.
previousAttempts	TimelineAttempt[]	이전 레코드가 시도됩니다.
queueId	integer	작업이 실행된 에이전트 풀에 프로젝트를 연결하는 큐의 ID입니다. 레코드가 Job 형식인 경우에 적용됩니다.
refName	string	참조된 레코드의 이름입니다.
result	TaskResult	레코드의 결과입니다.
resultCode	string	레코드 작업이 완료될 때 미리 정의된 조건 평가 예: 평가 `succeeded()`, 결과 = True 예: 평가 `and(succeeded(), eq(variables['system.debug'], False))`, 결과 = False
startTime	string	레코드의 시작 시간입니다.
state	TimelineRecordState	레코드의 상태입니다.
task	TaskReference	작업에 대한 참조입니다. 레코드가 Task 형식인 경우에 적용됩니다.
type	string	레코드에서 추적되는 작업의 유형입니다. 예: 단계, 단계, 작업, 작업...
variables	<string, VariableValue>	레코드의 변수입니다.
warningCount	integer	이 작업에서 생성된 경고 수입니다.
workerName	string	작업을 실행하는 에이전트의 이름입니다. 레코드가 Job 형식인 경우에 적용됩니다.

TimelineRecordState

레코드의 상태입니다.

Name	형식	Description
completed	string
inProgress	string
pending	string

TimelineReference

타임라인 대한 참조입니다.

Name	형식	Description
changeId	integer	변경 ID입니다.
id	string	타임라인 ID입니다.
location	string	타임라인 REST URL입니다.

VariableValue

제네릭 변수에 대한 래퍼 클래스입니다.

Name	형식	Description
isReadOnly	boolean	스크립트의 실행 런타임 동안 변수를 변경할 수 있는지 여부를 나타냅니다.
isSecret	boolean	변수를 미사용 시 암호화해야 하는지 여부를 나타냅니다.
value	string	변수의 값입니다.

VssJsonCollectionWrapper

이 클래스는 컬렉션을 와이어의 단일 JSON 개체로 직렬화하는 데 사용됩니다.

Name	형식	Description
count	integer	직렬화된 항목의 수입니다.
value	string	직렬화된 항목입니다.

다음을 통해 공유