Records - Update

Ссылка

Служба:: Distributed Task

Версия API:: 7.1

Обновите записи временной шкалы, если они уже существуют, в противном случае создайте новые для той же временной шкалы.

PATCH https://dev.azure.com/{organization}/{scopeIdentifier}/_apis/distributedtask/hubs/{hubName}/plans/{planId}/timelines/{timelineId}/records?api-version=7.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".

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

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

Ответы

Имя	Тип	Описание
200 OK	TimelineRecord[]	успешная операция

Безопасность

accessToken

Личный маркер доступа. Используйте любое значение для имени пользователя и маркера в качестве пароля.

Тип: basic

Примеры

Update timeline's records

Образец запроса

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
}

Пример ответа

Код состояния:: 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	Подробные сведения о выполнении различных операций во время выполнения конвейера.
TimelineRecordState	Состояние записи.
TimelineReference	Ссылка на временную шкалу.
VariableValue	Класс-оболочка для универсальной переменной.
VssJsonCollectionWrapper	Этот класс используется для сериализации коллекций в виде одного объекта JSON в проводной сети.

Issue

Object

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

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

IssueType

Перечисление

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

Значение	Описание
error
warning

JObject

Object

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

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

TaskLogReference

Object

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

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

TaskReference

Object

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

Имя	Тип	Описание
id	string (uuid)	Идентификатор определения задачи. Соответствует значению идентификатора файла task.json. Пример: CmdLineV2 { "id": "D9BAFED4-0B18-4F58-968D-8665B4D2CE9" }
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
canceled
failed
skipped
succeeded
succeededWithIssues

TimelineAttempt

Object

Попытка обновить временную шкалу.

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

TimelineRecord

Object

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

Имя	Тип	Описание
agentSpecification	JObject	Спецификация агента, выполняющего задание конвейера, в двоичном формате. Применимо, если запись имеет тип Job. Пример: { VMImage: "windows-2019" }
attempt	integer (int32)	Количество попыток записи.
changeId	integer (int32)	Идентификатор, подключающий все записи, обновляемые одновременно. Это значение берется из параметра ChangeId временной шкалы.
currentOperation	string	Строка, указывающая текущую операцию.
details	TimelineReference	Ссылка на под временную шкалу.
errorCount	integer (int32)	Количество ошибок, создаваемых этой операцией.
finishTime	string (date-time)	Время окончания записи.
id	string (uuid)	Идентификатор записи.
identifier	string	Строковый идентификатор, согласованный между попытками.
issues	Issue[]	Список проблем, создаваемых этой операцией.
lastModified	string (date-time)	Время последнего изменения записи.
location	string	URL-адрес REST записи.
log	TaskLogReference	Ссылка на журнал, созданный этой операцией.
name	string	Имя записи.
order	integer (int32)	Порядковое значение относительно других записей на временной шкале.
parentId	string (uuid)	Идентификатор родительского элемента записи. Пример. Этап является родительским элементом этапа, этап является родительским элементом задания, задание является родительским элементом задачи.
percentComplete	integer (int32)	Процент завершения записи.
previousAttempts	TimelineAttempt[]	Предыдущие попытки записи.
queueId	integer (int32)	Идентификатор очереди, которая подключает проекты к пулам агентов, в которой выполнялась операция. Применимо, если запись имеет тип Job.
refName	string	Имя указанной записи.
result	TaskResult	Результат записи.
resultCode	string	Оценка предопределенных условий после завершения операции записи. Пример: оценка `succeeded()`, результат = True Пример: оценка `and(succeeded(), eq(variables['system.debug'], False))`, результат = false
startTime	string (date-time)	Время начала записи.
state	TimelineRecordState	Состояние записи.
task	TaskReference	Ссылка на задачу. Применимо, если запись имеет тип Task.
type	string	Тип операции, отслеживаемой записью. Пример: этап, этап, задание, задача...
variables	<string, VariableValue>	Переменные записи.
warningCount	integer (int32)	Количество предупреждений, созданных этой операцией.
workerName	string	Имя агента, выполняющего операцию. Применимо, если запись имеет тип Job.

TimelineRecordState

Перечисление

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

Значение	Описание
completed
inProgress
pending

TimelineReference

Object

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

Имя	Тип	Описание
changeId	integer (int32)	Идентификатор изменения.
id	string (uuid)	Идентификатор временной шкалы.
location	string	URL-адрес rest временной шкалы.

VariableValue

Object

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

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

VssJsonCollectionWrapper

Object

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

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