Compartilhar via

Records - Update

  • Referência
Serviço:
Distributed Task
Versão da API:
7.1

Atualize os registros da linha do tempo se eles já existirem, caso contrário, crie novos para a mesma linha do tempo.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
hubName
 path True

string

O nome do hub do servidor. Exemplos comuns: "build", "rm", "checks"
organization
 path True

string

O nome da organização do Azure DevOps.
planId
 path True

string (uuid)

A ID do plano.
scopeIdentifier
 path True

string (uuid)

O GUID do projeto para definir o escopo da solicitação
timelineId
 path True

string (uuid)

A ID da linha do tempo.
api-version
 query True

string

Versão da API a ser usada. Isso deve ser definido como '7.1' para usar essa versão da api.

Corpo da solicitação

Nome Tipo Description
count

integer (int32)

O número de itens serializados.
value

string (T)

O item serializado.

Respostas

Nome Tipo Description
200 OK

TimelineRecord[]

operação bem-sucedida

Segurança

accessToken

Token de acesso pessoal. Use qualquer valor para o nome de usuário e o token como a senha.

Tipo: basic

Exemplos

Update timeline's records

Solicitação de exemplo

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
}

Resposta de exemplo

Código de status:
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
    }
  ]
}

Definições

Nome Description
Issue

Um problema (erro, aviso) associado a uma execução de pipeline.
IssueType

O tipo (erro, aviso) do problema.
JObject

Representa um objeto JSON.
TaskLogReference

Uma referência a um log de tarefas. Essa classe contém informações sobre a saída impressa no console de logs do registro da linha do tempo durante a execução do pipeline.
TaskReference

Uma referência a uma tarefa.
TaskResult
TimelineAttempt

Uma tentativa de atualizar um TimelineRecord.
TimelineRecord

Informações detalhadas sobre a execução de operações diferentes durante a execução do pipeline.
TimelineRecordState

O estado do registro.
TimelineReference

Uma referência a uma linha do tempo.
VariableValue

Uma classe wrapper para uma variável genérica.
VssJsonCollectionWrapper

Essa classe é usada para serializar coleções como um único objeto JSON no fio.

Issue

Objeto

Um problema (erro, aviso) associado a uma execução de pipeline.

Nome Tipo Description
category

string

A categoria do problema.
Exemplo: Código – refere-se a erros de compilação
Exemplo: Geral – refere-se a erros genéricos
data

object

Um dicionário que contém detalhes sobre o problema.
message

string

Uma descrição do problema.
type

IssueType

O tipo (erro, aviso) do problema.

IssueType

Enumeração

O tipo (erro, aviso) do problema.

Valor Description
error
warning

JObject

Objeto

Representa um objeto JSON.

Nome Tipo Description
item

string (JToken)

type

string (JTokenType)

Obtém o tipo de nó para este JToken.

TaskLogReference

Objeto

Uma referência a um log de tarefas. Essa classe contém informações sobre a saída impressa no console de logs do registro da linha do tempo durante a execução do pipeline.

Nome Tipo Description
id

integer (int32)

A ID do log de tarefas.
location

string

A URL REST do log de tarefas.

TaskReference

Objeto

Uma referência a uma tarefa.

Nome Tipo Description
id

string (uuid)

A ID da definição da tarefa. Corresponde ao valor da ID de task.json arquivo.
Exemplo: CmdLineV2 { "id": "D9BAFED4-0B18-4F58-968D-86655B4D2CE9" }
inputs

object

Um dicionário de entradas específico a uma definição de tarefa. Corresponde ao valor de entradas de task.json arquivo.
name

string

O nome da definição da tarefa. Corresponde ao valor do nome de task.json arquivo.
Exemplo: CmdLineV2 { "name": "CmdLine" }
version

string

A versão da definição da tarefa. Corresponde ao valor de versão de task.json arquivo.
Exemplo: CmdLineV2 { "version": { "Major": 2, "Minor": 212, "Patch": 0 } }

TaskResult

Enumeração
Valor Description
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues

TimelineAttempt

Objeto

Uma tentativa de atualizar um TimelineRecord.

Nome Tipo Description
attempt

integer (int32)

A tentativa do registro.
identifier

string

O identificador exclusivo do registro.
recordId

string (uuid)

O identificador de registro localizado na linha do tempo especificada.
timelineId

string (uuid)

O identificador da linha do tempo que possui o registro que representa essa tentativa.

TimelineRecord

Objeto

Informações detalhadas sobre a execução de operações diferentes durante a execução do pipeline.

Nome Tipo Description
agentSpecification

JObject

A especificação de um agente executando um trabalho de pipeline, em formato binário. Aplicável quando o registro é do tipo Trabalho.
Exemplo: { "VMImage" : "windows-2019" }
attempt

integer (int32)

O número de tentativas de registro.
changeId

integer (int32)

A ID que conecta todos os registros atualizados ao mesmo tempo. Esse valor é obtido do ChangeId da linha do tempo.
currentOperation

string

Uma cadeia de caracteres que indica a operação atual.
details

TimelineReference

Uma referência a uma sub-linha do tempo.
errorCount

integer (int32)

O número de erros produzidos por essa operação.
finishTime

string (date-time)

A hora de término do registro.
id

string (uuid)

A ID do registro.
identifier

string

Identificador de cadeia de caracteres consistente entre tentativas.
issues

Issue[]

A lista de problemas produzidos por essa operação.
lastModified

string (date-time)

A hora em que o registro foi modificado pela última vez.
location

string

A URL REST do registro.
log

TaskLogReference

Uma referência ao log produzido por essa operação.
name

string

O nome do registro.
order

integer (int32)

Um valor ordinal relativo a outros registros dentro da linha do tempo.
parentId

string (uuid)

A ID do pai do registro.
Exemplo: Stage é um pai de uma Fase, Phase é um pai de um trabalho, Job é um pai de uma tarefa.
percentComplete

integer (int32)

O percentual de conclusão do registro.
previousAttempts

TimelineAttempt[]

As tentativas de registro anteriores.
queueId

integer (int32)

A ID da fila que conecta projetos a pools de agentes nos quais a operação foi executada. Aplicável quando o registro é do tipo Trabalho.
refName

string

Nome do registro referenciado.
result

TaskResult

O resultado do registro.
resultCode

string

Avaliação de condições predefinidas após a conclusão da operação do registro.
Exemplo: Avaliando succeeded(), Resultado = True
Exemplo: Avaliando and(succeeded(), eq(variables['system.debug'], False)), Resultado = False
startTime

string (date-time)

A hora de início do registro.
state

TimelineRecordState

O estado do registro.
task

TaskReference

Uma referência à tarefa. Aplicável quando o registro é do tipo Tarefa.
type

string

O tipo de operação que está sendo controlada pelo registro.
Exemplo: Estágio, Fase, Trabalho, Tarefa...
variables

<string,  VariableValue>

As variáveis do registro.
warningCount

integer (int32)

O número de avisos produzidos por essa operação.
workerName

string

O nome do agente que está executando a operação. Aplicável quando o registro é do tipo Trabalho.

TimelineRecordState

Enumeração

O estado do registro.

Valor Description
completed
inProgress
pending

TimelineReference

Objeto

Uma referência a uma linha do tempo.

Nome Tipo Description
changeId

integer (int32)

A ID da alteração.
id

string (uuid)

A ID da linha do tempo.
location

string

A URL REST da linha do tempo.

VariableValue

Objeto

Uma classe wrapper para uma variável genérica.

Nome Tipo Description
isReadOnly

boolean

Indica se a variável pode ser alterada durante o runtime de execução do script.
isSecret

boolean

Indica se a variável deve ser criptografada em repouso.
value

string

O valor da variável.

VssJsonCollectionWrapper

Objeto

Essa classe é usada para serializar coleções como um único objeto JSON no fio.

Nome Tipo Description
count

integer (int32)

O número de itens serializados.
value

string (T)

O item serializado.