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

Имя	В	Обязательно	Тип	Описание
hubName	path	True	string	Имя концентратора сервера. Распространенные примеры: "build", "rm", "checks"
organization	path	True	string	Название организации Azure DevOps.
planId	path	True	string uuid	Идентификатор плана.
scopeIdentifier	path	True	string uuid	GUID проекта для область запроса
timelineId	path	True	string uuid	Идентификатор временная шкала.
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1.

Текст запроса

Имя	Тип	Описание
count	integer	Количество сериализованных элементов.
value	string	Сериализованный элемент.

Ответы

Имя	Тип	Описание
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
    }
  ]
}

Определения

Имя	Описание
Issue	Проблема (ошибка, предупреждение), связанная с выполнением конвейера.
IssueType	Тип проблемы (ошибка, предупреждение).
JObject	Представляет объект JSON.
TaskLogReference	Ссылка на журнал задач. Этот класс содержит сведения о выходных данных, выводимых в консоль журналов записи временная шкала во время выполнения конвейера.
TaskReference	Ссылка на задачу.
TaskResult
TimelineAttempt	Попытка обновить TimelineRecord.
TimelineRecord	Подробные сведения о выполнении различных операций во время выполнения конвейера.
TimelineRecordState	Состояние записи.
TimelineReference	Ссылка на временная шкала.
VariableValue	Класс-оболочка для универсальной переменной.
VssJsonCollectionWrapper	Этот класс используется для сериализации коллекций в виде одного объекта JSON по сети.

Issue

Проблема (ошибка, предупреждение), связанная с выполнением конвейера.

Имя	Тип	Описание
category	string	Категория проблемы. Пример. Код — ссылается на ошибки компиляции Пример: Общие — относится к универсальным ошибкам
data	object	Словарь, содержащий сведения о проблеме.
message	string	Описание проблемы.
type	IssueType	Тип проблемы (ошибка, предупреждение).

IssueType

Тип проблемы (ошибка, предупреждение).

Имя	Тип	Описание
error	string
warning	string

JObject

Представляет объект JSON.

Имя	Тип	Описание
item	string
type	string	Возвращает тип узла для этого JToken.

TaskLogReference

Ссылка на журнал задач. Этот класс содержит сведения о выходных данных, выводимых в консоль журналов записи временная шкала во время выполнения конвейера.

Имя	Тип	Описание
id	integer	Идентификатор журнала задач.
location	string	URL-адрес REST журнала задач.

TaskReference

Ссылка на задачу.

Имя	Тип	Описание
id	string	Идентификатор определения задачи. Соответствует значению id файла task.json. Пример: 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

Имя	Тип	Описание
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string

TimelineAttempt

Попытка обновить TimelineRecord.

Имя	Тип	Описание
attempt	integer	Попытка записи.
identifier	string	Уникальный идентификатор записи.
recordId	string	Идентификатор записи, расположенный в указанном временная шкала.
timelineId	string	Идентификатор временная шкала, которому принадлежит запись, представляющая эту попытку.

TimelineRecord

Подробные сведения о выполнении различных операций во время выполнения конвейера.

Имя	Тип	Описание
agentSpecification	JObject	Спецификация агента, выполняющего задание конвейера, в двоичном формате. Применимо, если запись относится к типу Job. Пример: { "VMImage": "windows-2019" }
attempt	integer	Количество попыток записи.
changeId	integer	Идентификатор, соединяющий все записи, обновляемые одновременно. Это значение берется из changeId временная шкала.
currentOperation	string	Строка, указывающая текущую операцию.
details	TimelineReference	Ссылка на под-временная шкала.
errorCount	integer	Количество ошибок, вызванных этой операцией.
finishTime	string	Время окончания записи.
id	string	Идентификатор записи.
identifier	string	Строковый идентификатор, согласованный в разных попытках.
issues	Issue[]	Список проблем, возникших в ходе этой операции.
lastModified	string	Время последнего изменения записи.
location	string	URL-адрес REST записи.
log	TaskLogReference	Ссылка на журнал, созданный этой операцией.
name	string	Имя записи.
order	integer	Порядковое значение относительно других записей в временная шкала.
parentId	string	Идентификатор родительского элемента записи. Пример. Этап является родительским элементом этапа, Phase — родительским элементом задания, Job — родительским элементом задачи.
percentComplete	integer	Процент завершения записи.
previousAttempts	TimelineAttempt[]	Предыдущие попытки записи.
queueId	integer	Идентификатор очереди, соединяющей проекты с пулами агентов, в которых выполнялась операция. Применимо, если запись относится к типу 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

Состояние записи.

Имя	Тип	Описание
completed	string
inProgress	string
pending	string

TimelineReference

Ссылка на временная шкала.

Имя	Тип	Описание
changeId	integer	Идентификатор изменения.
id	string	Идентификатор временная шкала.
location	string	URL-адрес REST временная шкала.

VariableValue

Класс-оболочка для универсальной переменной.

Имя	Тип	Описание
isReadOnly	boolean	Указывает, можно ли изменить переменную во время выполнения скрипта.
isSecret	boolean	Указывает, следует ли шифровать переменную при хранении.
value	string	Значение переменной.

VssJsonCollectionWrapper

Этот класс используется для сериализации коллекций в виде одного объекта JSON по сети.

Имя	Тип	Описание
count	integer	Количество сериализованных элементов.
value	string	Сериализованный элемент.

Поделиться через