Compartir a través de

Records - Update

  • Referencia
Servicio:
Distributed Task
Versión de la API:
7.1

Actualice los registros de escala de tiempo si ya existen; de lo contrario, cree otros nuevos para la misma escala de tiempo.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
hubName
 path True

string

Nombre del centro de servidores. Ejemplos comunes: "build", "rm", "checks"
organization
 path True

string

Nombre de la organización de Azure DevOps.
planId
 path True

string (uuid)

Identificador del plan.
scopeIdentifier
 path True

string (uuid)

GUID del proyecto para definir el ámbito de la solicitud
timelineId
 path True

string (uuid)

Identificador de la escala de tiempo.
api-version
 query True

string

Versión de la API que se va a usar. Debe establecerse en "7.1" para usar esta versión de la API.

Cuerpo de la solicitud

Nombre Tipo Description
count

integer (int32)

Número de elementos serializados.
value

string (T)

Elemento serializado.

Respuestas

Nombre Tipo Description
200 OK

TimelineRecord[]

operación correcta

Seguridad

accessToken

Token de acceso personal. Use cualquier valor para el nombre de usuario y el token como contraseña.

Tipo: basic

Ejemplos

Update timeline's records

Solicitud de ejemplo

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
}

Respuesta de muestra

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

Definiciones

Nombre Description
Issue

Un problema (error, advertencia) asociado a una ejecución de canalización.
IssueType

Tipo (error, advertencia) del problema.
JObject

Representa un objeto JSON.
TaskLogReference

Referencia a un registro de tareas. Esta clase contiene información sobre la salida impresa en la consola de registros del registro de escala de tiempo durante la ejecución de la canalización.
TaskReference

Referencia a una tarea.
TaskResult
TimelineAttempt

Intento de actualizar timelineRecord.
TimelineRecord

Información detallada sobre la ejecución de diferentes operaciones durante la ejecución de la canalización.
TimelineRecordState

Estado del registro.
TimelineReference

Referencia a una escala de tiempo.
VariableValue

Clase contenedora para una variable genérica.
VssJsonCollectionWrapper

Esta clase se usa para serializar colecciones como un único objeto JSON en la conexión.

Issue

Object

Un problema (error, advertencia) asociado a una ejecución de canalización.

Nombre Tipo Description
category

string

Categoría del problema.
Ejemplo: Código: hace referencia a errores de compilación
Ejemplo: General: hace referencia a errores genéricos
data

object

Diccionario que contiene detalles sobre el problema.
message

string

Descripción del problema.
type

IssueType

Tipo (error, advertencia) del problema.

IssueType

Enumeración

Tipo (error, advertencia) del problema.

Valor Description
error
warning

JObject

Object

Representa un objeto JSON.

Nombre Tipo Description
item

string (JToken)

type

string (JTokenType)

Obtiene el tipo de nodo para este JToken.

TaskLogReference

Object

Referencia a un registro de tareas. Esta clase contiene información sobre la salida impresa en la consola de registros del registro de escala de tiempo durante la ejecución de la canalización.

Nombre Tipo Description
id

integer (int32)

Identificador del registro de tareas.
location

string

Dirección URL de REST del registro de tareas.

TaskReference

Object

Referencia a una tarea.

Nombre Tipo Description
id

string (uuid)

Identificador de la definición de tarea. Corresponde al valor id de task.json archivo.
Ejemplo: CmdLineV2 { "id": "D9BAFED4-0B18-4F58-968D-86655B4D2CE9" }
inputs

object

Diccionario de entradas específicas de una definición de tarea. Corresponde al valor de entradas del archivo task.json.
name

string

Nombre de la definición de tarea. Corresponde al valor de nombre del archivo task.json.
Ejemplo: CmdLineV2 { "name": "CmdLine" }
version

string

Versión de la definición de tarea. Corresponde al valor de versión de task.json archivo.
Ejemplo: CmdLineV2 { "version": { "Major": 2, "Minor": 212, "Patch": 0 } }

TaskResult

Enumeración
Valor Description
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues

TimelineAttempt

Object

Intento de actualizar timelineRecord.

Nombre Tipo Description
attempt

integer (int32)

El intento del registro.
identifier

string

Identificador único del registro.
recordId

string (uuid)

Identificador de registro ubicado dentro de la escala de tiempo especificada.
timelineId

string (uuid)

Identificador de escala de tiempo que posee el registro que representa este intento.

TimelineRecord

Object

Información detallada sobre la ejecución de diferentes operaciones durante la ejecución de la canalización.

Nombre Tipo Description
agentSpecification

JObject

Especificación de un agente que ejecuta un trabajo de canalización, en formato binario. Aplicable cuando el registro es de tipo Trabajo.
Ejemplo: { "VMImage" : "windows-2019" }
attempt

integer (int32)

Número de intentos de registro.
changeId

integer (int32)

Identificador que conecta todos los registros actualizados al mismo tiempo. Este valor se toma del ChangeId de la escala de tiempo.
currentOperation

string

Cadena que indica la operación actual.
details

TimelineReference

Referencia a una sub-escala de tiempo.
errorCount

integer (int32)

Número de errores generados por esta operación.
finishTime

string (date-time)

Hora de finalización del registro.
id

string (uuid)

Identificador del registro.
identifier

string

Identificador de cadena coherente entre intentos.
issues

Issue[]

Lista de problemas generados por esta operación.
lastModified

string (date-time)

Hora en que se modificó por última vez el registro.
location

string

Dirección URL de REST del registro.
log

TaskLogReference

Referencia al registro generado por esta operación.
name

string

Nombre del registro.
order

integer (int32)

Valor ordinal relativo a otros registros dentro de la escala de tiempo.
parentId

string (uuid)

Identificador del elemento primario del registro.
Ejemplo: Stage es un elemento primario de una fase, Phase es un elemento primario de un trabajo, Job es un elemento primario de una tarea.
percentComplete

integer (int32)

Porcentaje de finalización del registro.
previousAttempts

TimelineAttempt[]

Los intentos de registro anteriores.
queueId

integer (int32)

Identificador de la cola que conecta proyectos a grupos de agentes en los que se ejecutó la operación. Aplicable cuando el registro es de tipo Trabajo.
refName

string

Nombre del registro al que se hace referencia.
result

TaskResult

Resultado del registro.
resultCode

string

Evaluación de condiciones predefinidas tras la finalización de la operación del registro.
Ejemplo: Evaluación de succeeded(), Resultado = True
Ejemplo: Evaluación de and(succeeded(), eq(variables['system.debug'], False)), Resultado = False
startTime

string (date-time)

Hora de inicio del registro.
state

TimelineRecordState

Estado del registro.
task

TaskReference

Referencia a la tarea. Aplicable cuando el registro es de tipo Task.
type

string

Tipo de operación que realiza el seguimiento del registro.
Ejemplo: Fase, Fase, Trabajo, Tarea...
variables

<string,  VariableValue>

Variables del registro.
warningCount

integer (int32)

Número de advertencias producidas por esta operación.
workerName

string

Nombre del agente que ejecuta la operación. Aplicable cuando el registro es de tipo Trabajo.

TimelineRecordState

Enumeración

Estado del registro.

Valor Description
completed
inProgress
pending

TimelineReference

Object

Referencia a una escala de tiempo.

Nombre Tipo Description
changeId

integer (int32)

Identificador de cambio.
id

string (uuid)

Identificador de la escala de tiempo.
location

string

Dirección URL de REST de la escala de tiempo.

VariableValue

Object

Clase contenedora para una variable genérica.

Nombre Tipo Description
isReadOnly

boolean

Indica si la variable se puede cambiar durante el tiempo de ejecución del script.
isSecret

boolean

Indica si la variable debe cifrarse en reposo.
value

string

Valor de la variable.

VssJsonCollectionWrapper

Object

Esta clase se usa para serializar colecciones como un único objeto JSON en la conexión.

Nombre Tipo Description
count

integer (int32)

Número de elementos serializados.
value

string (T)

Elemento serializado.