Records - Update

Référence

Service:: Distributed Task

API Version:: 7.1-preview.1

Mettez à jour chronologie enregistrements s’ils existent déjà; sinon, créez-en de nouveaux pour le même chronologie.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
hubName	path	True	string	Nom du hub de serveur. Exemples courants : « build », « rm », « checks »
organization	path	True	string	Nom de l’organisation Azure DevOps.
planId	path	True	string uuid	ID du plan.
scopeIdentifier	path	True	string uuid	GUID du projet pour étendre la demande
timelineId	path	True	string uuid	ID du chronologie.
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.1 » pour utiliser cette version de l’API.

Corps de la demande

Nom	Type	Description
count	integer	Nombre d’éléments sérialisés.
value	string	Élément sérialisé.

Réponses

Nom	Type	Description
200 OK	TimelineRecord[]	opération réussie

Sécurité

accessToken

Jeton d’accès personnel. Utilisez n’importe quelle valeur pour le nom d’utilisateur et le jeton comme mot de passe.

Type: basic

Exemples

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

Définitions

Nom	Description
Issue	Problème (erreur, avertissement) associé à une exécution de pipeline.
IssueType	Type (erreur, avertissement) du problème.
JObject	Représente un objet JSON.
TaskLogReference	Référence à un journal des tâches. Cette classe contient des informations sur la sortie imprimée dans la console journaux de l’enregistrement chronologie pendant l’exécution du pipeline.
TaskReference	Référence à une tâche.
TaskResult
TimelineAttempt	Tentative de mise à jour d’un objet TimelineRecord.
TimelineRecord	Informations détaillées sur l’exécution de différentes opérations pendant l’exécution du pipeline.
TimelineRecordState	État de l’enregistrement.
TimelineReference	Référence à un chronologie.
VariableValue	Classe wrapper pour une variable générique.
VssJsonCollectionWrapper	Cette classe est utilisée pour sérialiser des collections en tant qu’objet JSON unique sur le réseau.

Issue

Problème (erreur, avertissement) associé à une exécution de pipeline.

Nom	Type	Description
category	string	Catégorie du problème. Exemple : Code - fait référence aux erreurs de compilation Exemple : Général : fait référence aux erreurs génériques
data	object	Dictionnaire contenant des détails sur le problème.
message	string	Description du problème.
type	IssueType	Type (erreur, avertissement) du problème.

IssueType

Type (erreur, avertissement) du problème.

Nom	Type	Description
error	string
warning	string

JObject

Représente un objet JSON.

Nom	Type	Description
item	string
type	string	Obtient le type de nœud pour ce JToken.

TaskLogReference

Référence à un journal des tâches. Cette classe contient des informations sur la sortie imprimée dans la console journaux de l’enregistrement chronologie pendant l’exécution du pipeline.

Nom	Type	Description
id	integer	ID du journal des tâches.
location	string	URL REST du journal des tâches.

TaskReference

Référence à une tâche.

Nom	Type	Description
id	string	ID de la définition de tâche. Correspond à la valeur id du fichier task.json. Exemple : CmdLineV2 { « id »: « D9BAFED4-0B18-4F58-968D-86655B4D2CE9 » }
inputs	object	Dictionnaire d’entrées spécifiques à une définition de tâche. Correspond à la valeur d’entrée du fichier task.json.
name	string	Nom de la définition de tâche. Correspond à la valeur de nom du fichier task.json. Exemple : CmdLineV2 { « name »: « CmdLine » }
version	string	Version de la définition de tâche. Correspond à la valeur de version du fichier task.json. Exemple : CmdLineV2 { « version »: { « Major »: 2, « Minor »: 212, « Patch »: 0 } }

TaskResult

Nom	Type	Description
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string

TimelineAttempt

Tentative de mise à jour d’un objet TimelineRecord.

Nom	Type	Description
attempt	integer	Tentative de l’enregistrement.
identifier	string	Identificateur unique de l’enregistrement.
recordId	string	Identificateur d’enregistrement situé dans le chronologie spécifié.
timelineId	string	L’identificateur chronologie qui possède l’enregistrement représentant cette tentative.

TimelineRecord

Informations détaillées sur l’exécution de différentes opérations pendant l’exécution du pipeline.

Nom	Type	Description
agentSpecification	JObject	Spécification d’un agent exécutant un travail de pipeline, au format binaire. Applicable lorsque l’enregistrement est de type Travail. Exemple : { « VMImage » : « windows-2019 » }
attempt	integer	Nombre de tentatives d’enregistrement.
changeId	integer	ID de connexion de tous les enregistrements mis à jour en même temps. Cette valeur est extraite du ChangeId de chronologie.
currentOperation	string	Chaîne qui indique l’opération en cours.
details	TimelineReference	Référence à une sous-chronologie.
errorCount	integer	Nombre d’erreurs générées par cette opération.
finishTime	string	Heure de fin de l’enregistrement.
id	string	ID de l’enregistrement.
identifier	string	Identificateur de chaîne cohérent entre les tentatives.
issues	Issue[]	Liste des problèmes générés par cette opération.
lastModified	string	Heure de la dernière modification de l’enregistrement.
location	string	URL REST de l’enregistrement.
log	TaskLogReference	Référence au journal généré par cette opération.
name	string	Nom de l'enregistrement.
order	integer	Valeur ordinale relative à d’autres enregistrements dans le chronologie.
parentId	string	ID du parent de l’enregistrement. Exemple : Stage est un parent d’une phase, Phase est un parent d’un travail, Job est un parent d’une tâche.
percentComplete	integer	Pourcentage d’achèvement de l’enregistrement.
previousAttempts	TimelineAttempt[]	Tentatives d’enregistrement précédentes.
queueId	integer	ID de la file d’attente qui connecte les projets aux pools d’agents sur lesquels l’opération s’est exécutée. Applicable lorsque l’enregistrement est de type Travail.
refName	string	Nom de l’enregistrement référencé.
result	TaskResult	Résultat de l’enregistrement.
resultCode	string	Évaluation des conditions prédéfinies à la fin de l’opération de l’enregistrement. Exemple : Évaluation de `succeeded()`, Result = True Exemple : Évaluation de `and(succeeded(), eq(variables['system.debug'], False))`, Result = False
startTime	string	Heure de début de l’enregistrement.
state	TimelineRecordState	État de l’enregistrement.
task	TaskReference	Référence à la tâche. Applicable lorsque l’enregistrement est de type Task.
type	string	Type d’opération suivi par l’enregistrement. Exemple : Étape, Phase, Travail, Tâche...
variables	<string, VariableValue>	Variables de l’enregistrement.
warningCount	integer	Nombre d’avertissements générés par cette opération.
workerName	string	Nom de l’agent exécutant l’opération. Applicable lorsque l’enregistrement est de type Travail.

TimelineRecordState

État de l’enregistrement.

Nom	Type	Description
completed	string
inProgress	string
pending	string

TimelineReference

Référence à un chronologie.

Nom	Type	Description
changeId	integer	ID de modification.
id	string	ID du chronologie.
location	string	URL REST du chronologie.

VariableValue

Classe wrapper pour une variable générique.

Nom	Type	Description
isReadOnly	boolean	Indique si la variable peut être modifiée pendant l’exécution du script.
isSecret	boolean	Indique si la variable doit être chiffrée au repos.
value	string	Valeur de la variable.

VssJsonCollectionWrapper

Cette classe est utilisée pour sérialiser des collections en tant qu’objet JSON unique sur le réseau.

Nom	Type	Description
count	integer	Nombre d’éléments sérialisés.
value	string	Élément sérialisé.

Partager via