Records - Update

Riferimento

Service:: Distributed Task

API Version:: 7.1-preview.1

Aggiornare i record della sequenza temporale, se già esistenti, in caso contrario crearne di nuovi per la stessa sequenza temporale.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
hubName	path	True	string	Nome dell'hub del server. Esempi comuni: "build", "rm", "checks"
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
planId	path	True	string uuid	ID del piano.
scopeIdentifier	path	True	string uuid	GUID del progetto per definire l'ambito della richiesta
timelineId	path	True	string uuid	ID della sequenza temporale.
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '7.1-preview.1' per usare questa versione dell'API.

Corpo della richiesta

Nome	Tipo	Descrizione
count	integer	Numero di elementi serializzati.
value	string	Elemento serializzato.

Risposte

Nome	Tipo	Descrizione
200 OK	TimelineRecord[]	operazione riuscita

Sicurezza

accessToken

Token di accesso personale. Usare qualsiasi valore per il nome utente e il token come password.

Type: basic

Esempio

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

Definizioni

Nome	Descrizione
Issue	Problema (errore, avviso) associato a un'esecuzione della pipeline.
IssueType	Tipo (errore, avviso) del problema.
JObject	Rappresenta un oggetto JSON.
TaskLogReference	Riferimento a un log attività. Questa classe contiene informazioni sull'output stampato nella console dei log del record della sequenza temporale durante l'esecuzione della pipeline.
TaskReference	Riferimento a un'attività.
TaskResult
TimelineAttempt	Tentativo di aggiornare un oggetto TimelineRecord.
TimelineRecord	Informazioni dettagliate sull'esecuzione di diverse operazioni durante l'esecuzione della pipeline.
TimelineRecordState	Stato del record.
TimelineReference	Riferimento a una sequenza temporale.
VariableValue	Classe wrapper per una variabile generica.
VssJsonCollectionWrapper	Questa classe viene usata per serializzare le raccolte come singolo oggetto JSON in transito.

Issue

Problema (errore, avviso) associato a un'esecuzione della pipeline.

Nome	Tipo	Descrizione
category	string	Categoria del problema. Esempio: codice : fa riferimento agli errori di compilazione Esempio: Generale : fa riferimento a errori generici
data	object	Dizionario contenente informazioni dettagliate sul problema.
message	string	Descrizione del problema.
type	IssueType	Tipo (errore, avviso) del problema.

IssueType

Tipo (errore, avviso) del problema.

Nome	Tipo	Descrizione
error	string
warning	string

JObject

Rappresenta un oggetto JSON.

Nome	Tipo	Descrizione
item	string
type	string	Ottiene il tipo di nodo per questo JToken.

TaskLogReference

Riferimento a un log attività. Questa classe contiene informazioni sull'output stampato nella console dei log del record della sequenza temporale durante l'esecuzione della pipeline.

Nome	Tipo	Descrizione
id	integer	ID del log attività.
location	string	URL REST del log attività.

TaskReference

Riferimento a un'attività.

Nome	Tipo	Descrizione
id	string	ID della definizione dell'attività. Corrisponde al valore ID del file task.json. Esempio: CmdLineV2 { "id": "D9BAFED4-0B18-4F58-968D-86655B4D2CE9" }
inputs	object	Dizionario di input specifico di una definizione di attività. Corrisponde al valore di input del file task.json.
name	string	Nome della definizione dell'attività. Corrisponde al valore del nome del file task.json. Esempio: CmdLineV2 { "name": "CmdLine" }
version	string	Versione della definizione dell'attività. Corrisponde al valore della versione del file task.json. Esempio: CmdLineV2 { "version": { "Major": 2, "Minor": 212, "Patch": 0 } }

TaskResult

Nome	Tipo	Descrizione
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string

TimelineAttempt

Tentativo di aggiornare un oggetto TimelineRecord.

Nome	Tipo	Descrizione
attempt	integer	Tentativo del record.
identifier	string	Identificatore univoco per il record.
recordId	string	Identificatore di record che si trova all'interno della sequenza temporale specificata.
timelineId	string	Identificatore della sequenza temporale proprietario del record che rappresenta questo tentativo.

TimelineRecord

Informazioni dettagliate sull'esecuzione di diverse operazioni durante l'esecuzione della pipeline.

Nome	Tipo	Descrizione
agentSpecification	JObject	Specifica di un agente che esegue un processo della pipeline, in formato binario. Applicabile quando il record è di tipo Job. Esempio: { "VMImage" : "windows-2019" }
attempt	integer	Numero di tentativi di record.
changeId	integer	ID che connette tutti i record aggiornati contemporaneamente. Questo valore viene ricavato dal ChangeId della sequenza temporale.
currentOperation	string	Stringa che indica l'operazione corrente.
details	TimelineReference	Riferimento a una sequenza temporale secondaria.
errorCount	integer	Numero di errori generati da questa operazione.
finishTime	string	Ora di fine del record.
id	string	ID del record.
identifier	string	Identificatore stringa coerente tra i tentativi.
issues	Issue[]	Elenco di problemi generati da questa operazione.
lastModified	string	Ora dell'ultima modifica del record.
location	string	URL REST del record.
log	TaskLogReference	Riferimento al log prodotto da questa operazione.
name	string	Nome del record.
order	integer	Valore ordinale relativo ad altri record all'interno della sequenza temporale.
parentId	string	ID dell'elemento padre del record. Esempio: Stage è un elemento padre di una fase, Phase è un elemento padre di un processo, Job è un elemento padre di un'attività.
percentComplete	integer	Percentuale di completamento del record.
previousAttempts	TimelineAttempt[]	Tentativi di record precedenti.
queueId	integer	ID della coda che connette i progetti ai pool di agenti su cui è stata eseguita l'operazione. Applicabile quando il record è di tipo Job.
refName	string	Nome del record a cui si fa riferimento.
result	TaskResult	Risultato del record.
resultCode	string	Valutazione delle condizioni predefinite al completamento dell'operazione del record. Esempio: Valutazione di `succeeded()`, Risultato = True Esempio: Valutazione di `and(succeeded(), eq(variables['system.debug'], False))`, Risultato = False
startTime	string	Ora di inizio del record.
state	TimelineRecordState	Stato del record.
task	TaskReference	Riferimento all'attività. Applicabile quando il record è di tipo Task.
type	string	Tipo di operazione rilevata dal record. Esempio: Stage, Phase, Job, Task...
variables	<string, VariableValue>	Variabili del record.
warningCount	integer	Numero di avvisi generati da questa operazione.
workerName	string	Nome dell'agente che esegue l'operazione. Applicabile quando il record è di tipo Job.

TimelineRecordState

Stato del record.

Nome	Tipo	Descrizione
completed	string
inProgress	string
pending	string

TimelineReference

Riferimento a una sequenza temporale.

Nome	Tipo	Descrizione
changeId	integer	ID di modifica.
id	string	ID della sequenza temporale.
location	string	URL REST della sequenza temporale.

VariableValue

Classe wrapper per una variabile generica.

Nome	Tipo	Descrizione
isReadOnly	boolean	Indica se la variabile può essere modificata durante il runtime di esecuzione dello script.
isSecret	boolean	Indica se la variabile deve essere crittografata inattiva.
value	string	Valore della variabile.

VssJsonCollectionWrapper

Questa classe viene usata per serializzare le raccolte come singolo oggetto JSON in transito.

Nome	Tipo	Descrizione
count	integer	Numero di elementi serializzati.
value	string	Elemento serializzato.

Condividi tramite