WorkItemTrackingRestClient class

Référence

Paquet:: azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes aux API REST VSS

Extends: RestClientBase

Constructeurs

WorkItemTrackingRestClient(IVssRestClientOptions)

Propriétés

RESOURCE_AREA_ID

Méthodes

createAttachment(any, string, string, string, string)	Charge une pièce jointe.
createField(WorkItemField, string)	Créez un champ.
createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Créez ou mettez à jour un nœud de classification existant.
createQuery(QueryHierarchyItem, string, string, boolean)	Crée une requête ou déplace une requête.
createTemplate(WorkItemTemplate, string, string)	Crée un modèle
createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)	Crée un seul élément de travail.
deleteClassificationNode(string, TreeStructureGroup, string, number)	Supprimer un nœud de classification existant.
deleteField(string, string)	Supprime le champ. Pour annuler la suppression d’un fichier, consultez l’API « Mettre à jour le champ ».
deleteQuery(string, string)	Supprimer une requête ou un dossier. Cela supprime toute modification d’autorisation sur la requête ou le dossier supprimé et l’un de ses descendants s’il s’agit d’un dossier. Il est important de noter que les modifications d’autorisation supprimées ne peuvent pas être récupérées lors de la suppression de la requête ou du dossier.
deleteTemplate(string, string, string)	Supprime le modèle avec l’ID donné
deleteWorkItem(number, string, boolean)	Supprime l’élément de travail spécifié et l’envoie à la Corbeille, afin qu’il puisse être restauré, si nécessaire. Si vous le souhaitez, si le paramètre destroy a été défini sur true, il détruit définitivement l’élément de travail. AVERTISSEMENT : si le paramètre destroy a la valeur true, les éléments de travail supprimés par cette commande n’iront PAS à la corbeille et il n’existe aucun moyen de les restaurer/récupérer après la suppression. Il est recommandé de NE PAS utiliser ce paramètre. Dans ce cas, utilisez ce paramètre avec une extrême prudence.
destroyWorkItem(number, string)	Détruit définitivement l’élément de travail spécifié à partir de la Corbeille. Cette action ne peut pas être annulée.
exportWorkItemTypeDefinition(string, string, boolean)	Exporter le type d’élément de travail
getAccountMyWorkData(QueryOption)	INTERNE UNIQUEMENT : UTILISÉ PAR LA PAGE MON TRAVAIL DU COMPTE. Cette opération renvoie les détails des éléments de travail Doing, Done, Suivi et Activity.
getAttachmentContent(string, string, string, boolean)	Télécharge une pièce jointe.
getAttachmentZip(string, string, string, boolean)	Télécharge une pièce jointe.
getClassificationNode(string, TreeStructureGroup, string, number)	Obtient le nœud de classification pour un chemin de nœud donné.
getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)	Obtient les nœuds de classification racine ou la liste des nœuds de classification pour une liste donnée d’ID de nœuds, pour un projet donné. Si le paramètre ids est fourni, vous obtenez la liste des nœuds de classification pour ces ID. Sinon, vous obtiendrez des nœuds de classification racine pour ce projet.
getComment(number, number, string)	Obtient un commentaire pour un élément de travail à la révision spécifiée.
getComments(number, string, number, number, CommentSortOrder)	Obtient le nombre spécifié de commentaires pour un élément de travail à partir de la révision spécifiée.
getDeletedWorkItem(number, string)	Obtient un élément de travail supprimé de la Corbeille.
getDeletedWorkItems(number[], string)	Obtient les éléments de travail de la corbeille, dont les ID ont été spécifiés dans les paramètres
getDeletedWorkItemShallowReferences(string)	Obtient une liste des ID et des URL des éléments de travail supprimés dans la Corbeille.
getField(string, string)	Obtient des informations sur un champ spécifique.
getFields(string, GetFieldsExpand)	Retourne des informations pour tous les champs. Le paramètre ID/nom du projet est facultatif.
getQueries(string, QueryExpand, number, boolean)	Obtient les requêtes racine et leurs enfants
getQueriesBatch(QueryBatchGetRequest, string)	Obtient une liste de requêtes par ids (maximum 1000)
getQuery(string, string, QueryExpand, number, boolean, boolean)	Récupère une requête individuelle et ses enfants
getQueryResultCount(string, string, string, boolean, number)	Obtient les résultats de la requête en fonction de l’ID de requête.
getRecentActivityData()	Obtient les activités d’élément de travail récentes
getRecentMentions()	INTERNE UNIQUEMENT : UTILISÉ PAR LA PAGE MON TRAVAIL DU COMPTE.
getRelationType(string)	Obtient la définition du type de relation d’élément de travail.
getRelationTypes()	Obtient les types de relation d’élément de travail.
getReportingLinksByLinkType(string, string[], string[], string, Date)	Obtenir un lot de liens d’éléments de travail
getRevision(number, number, string, WorkItemExpand)	Retourne un élément de travail entièrement hydraté pour la révision demandée
getRevisions(number, string, number, number, WorkItemExpand)	Retourne la liste des révisions d’éléments de travail entièrement hydratées, paginées.
getRootNodes(string, number)	Obtient les nœuds de classification racine sous le projet.
getTemplate(string, string, string)	Obtient le modèle avec l’ID spécifié
getTemplates(string, string, string)	Obtient le modèle
getUpdate(number, number, string)	Retourne une mise à jour unique pour un élément de travail
getUpdates(number, string, number, number)	Retourne les deltas entre les révisions d’élément de travail
getWorkArtifactLinkTypes()	Obtenez la liste des types de liens d’artefact sortants de suivi des éléments de travail.
getWorkItem(number, string, string[], Date, WorkItemExpand)	Retourne un seul élément de travail.
getWorkItemIconJson(string, string, number)	Obtenez une icône d’élément de travail en fonction du nom convivial et de la couleur de l’icône.
getWorkItemIcons()	Obtenez la liste de toutes les icônes d’élément de travail.
getWorkItemIconSvg(string, string, number)	Obtenez une icône d’élément de travail en fonction du nom convivial et de la couleur de l’icône.
getWorkItemIconXaml(string, string, number)	Obtenez une icône d’élément de travail en fonction du nom convivial et de la couleur de l’icône.
getWorkItemNextStatesOnCheckinAction(number[], string)	Retourne l’état suivant sur les ID d’élément de travail donnés.
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)	Retourne une liste d’éléments de travail (maximum 200)
getWorkItemsBatch(WorkItemBatchGetRequest, string)	Obtient des éléments de travail pour une liste d’ID d’élément de travail (maximum 200)
getWorkItemStateColors(string[])	INTERNE UNIQUEMENT : il sera utilisé pour l’expérience professionnelle de Mon compte. Obtenir la couleur d’état du type d’élément de travail pour plusieurs projets
getWorkItemTemplate(string, string, string, Date, WorkItemExpand)	Retourne un seul élément de travail à partir d’un modèle.
getWorkItemType(string, string)	Retourne une définition de type d’élément de travail.
getWorkItemTypeCategories(string)	Obtenir toutes les catégories de type d’élément de travail.
getWorkItemTypeCategory(string, string)	Obtenir une catégorie de type d’élément de travail spécifique par nom.
getWorkItemTypeColorAndIcons(string[])	INTERNE UNIQUEMENT : il est utilisé pour les fournisseurs de couleurs et d’icônes. Obtenir la couleur de type wit pour plusieurs projets
getWorkItemTypeColors(string[])	INTERNE UNIQUEMENT : il sera utilisé pour l’expérience professionnelle De mon compte. Obtenir la couleur de type wit pour plusieurs projets
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)	Obtenir la liste des champs d’un type d’élément de travail avec des références détaillées.
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)	Obtenir un champ pour un type d’élément de travail avec des références détaillées.
getWorkItemTypes(string)	Retourne la liste des types d’éléments de travail
getWorkItemTypeStates(string, string)	Retourne les noms d’état et les couleurs d’un type d’élément de travail.
queryById(string, string, string, boolean, number)	Obtient les résultats de la requête en fonction de l’ID de requête.
queryByWiql(Wiql, string, string, boolean, number)	Obtient les résultats de la requête en fonction de son WIQL.
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)	Requêtes éléments de travail liés à une liste donnée d’URI d’artefact.
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)	Obtenir un lot de révisions d’éléments de travail avec la possibilité d’inclure des éléments supprimés
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)	Obtenir un lot de révisions d’élément de travail. Cette requête peut être utilisée si votre liste de champs est suffisamment grande pour qu’elle puisse exécuter l’URL au-dessus de la limite de longueur.
replaceTemplate(WorkItemTemplate, string, string, string)	Remplacer le contenu du modèle
restoreWorkItem(WorkItemDeleteUpdate, number, string)	Restaure l’élément de travail supprimé de la Corbeille.
searchQueries(string, string, number, QueryExpand, boolean)	Recherche toutes les requêtes à laquelle l’utilisateur a accès dans le projet actuel
sendMail(SendMailBody, string)	Méthode RESTful pour envoyer des messages pour les éléments de travail sélectionnés/interrogés.
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Mettre à jour un nœud de classification existant.
updateField(UpdateWorkItemField, string, string)	Mettre à jour un champ.
updateQuery(QueryHierarchyItem, string, string, boolean)	Mettez à jour une requête ou un dossier. Cela vous permet de mettre à jour, de renommer et de déplacer des requêtes et des dossiers.
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)	Mises à jour un seul élément de travail.
updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)	Ajouter/mettre à jour un type d’élément de travail

Détails du constructeur

WorkItemTrackingRestClient(IVssRestClientOptions)

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

Paramètres

options: IVssRestClientOptions

Détails de la propriété

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valeur de propriété

string

Détails de la méthode

createAttachment(any, string, string, string, string)

Charge une pièce jointe.

function createAttachment(content: any, project?: string, fileName?: string, uploadType?: string, areaPath?: string): Promise<AttachmentReference>

Paramètres

content: any

Contenu à charger

project: string

ID de projet ou nom du projet

fileName: string

Nom du fichier

uploadType: string

Type de chargement de pièce jointe : simple ou segmenté

areaPath: string

Chemin de la zone du projet cible

Retours

Promise<AttachmentReference>

createField(WorkItemField, string)

Créez un champ.

function createField(workItemField: WorkItemField, project?: string): Promise<WorkItemField>

Paramètres

workItemField: WorkItemField

Nouvelle définition de champ

project: string

ID de projet ou nom du projet

Retours

Promise<WorkItemField>

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Créez ou mettez à jour un nœud de classification existant.

function createOrUpdateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>

Paramètres

postedNode: WorkItemClassificationNode

Nœud à créer ou à mettre à jour.

project: string

ID de projet ou nom du projet

structureGroup: TreeStructureGroup

Groupe de structure du nœud de classification, de la zone ou de l’itération.

path: string

Chemin du nœud de classification.

Retours

Promise<WorkItemClassificationNode>

createQuery(QueryHierarchyItem, string, string, boolean)

Crée une requête ou déplace une requête.

function createQuery(postedQuery: QueryHierarchyItem, project: string, query: string, validateWiqlOnly?: boolean): Promise<QueryHierarchyItem>

Paramètres

postedQuery: QueryHierarchyItem

Requête à créer.

project: string

ID de projet ou nom du projet

query: string

ID ou chemin d’accès parent sous lequel la requête doit être créée.

validateWiqlOnly: boolean

Si vous souhaitez uniquement valider votre requête WIQL sans en créer une, définissez-la sur true. La valeur par défaut est false.

Retours

Promise<QueryHierarchyItem>

createTemplate(WorkItemTemplate, string, string)

Crée un modèle

function createTemplate(template: WorkItemTemplate, project: string, team: string): Promise<WorkItemTemplate>

Paramètres

template: WorkItemTemplate

Contenu du modèle

project: string

ID de projet ou nom du projet

team: string

ID d’équipe ou nom de l’équipe

Retours

Promise<WorkItemTemplate>

createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)

Crée un seul élément de travail.

function createWorkItem(document: JsonPatchDocument, project: string, type: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemExpand): Promise<WorkItem>

Paramètres

document: JsonPatchDocument

Document JSON Patch représentant l’élément de travail

project: string

ID de projet ou nom du projet

type: string

Type d’élément de travail de l’élément de travail à créer

validateOnly: boolean

Indiquez si vous souhaitez uniquement valider les modifications sans enregistrer l’élément de travail

bypassRules: boolean

N’appliquez pas les règles de type d’élément de travail sur cette mise à jour

suppressNotifications: boolean

Ne pas déclencher de notifications pour cette modification

expand: WorkItemExpand

Paramètres de développement pour les attributs d’élément de travail. Les options possibles sont { None, Relations, Fields, Links, All }.

Retours

Promise<WorkItem>

deleteClassificationNode(string, TreeStructureGroup, string, number)

Supprimer un nœud de classification existant.

function deleteClassificationNode(project: string, structureGroup: TreeStructureGroup, path?: string, reclassifyId?: number): Promise<void>

Paramètres

project: string

ID de projet ou nom du projet

structureGroup: TreeStructureGroup

Groupe de structure du nœud de classification, de la zone ou de l’itération.

path: string

Chemin du nœud de classification.

reclassifyId: number

ID du nœud de classification cible pour la reclassification.

Retours

Promise<void>

deleteField(string, string)

Supprime le champ. Pour annuler la suppression d’un fichier, consultez l’API « Mettre à jour le champ ».

function deleteField(fieldNameOrRefName: string, project?: string): Promise<void>

Paramètres

fieldNameOrRefName: string

Nom simple de champ ou nom de référence

project: string

ID de projet ou nom du projet

Retours

Promise<void>

deleteQuery(string, string)

Supprimer une requête ou un dossier. Cela supprime toute modification d’autorisation sur la requête ou le dossier supprimé et l’un de ses descendants s’il s’agit d’un dossier. Il est important de noter que les modifications d’autorisation supprimées ne peuvent pas être récupérées lors de la suppression de la requête ou du dossier.

function deleteQuery(project: string, query: string): Promise<void>

Paramètres

project: string

ID de projet ou nom du projet

query: string

ID ou chemin d’accès de la requête ou du dossier à supprimer.

Retours

Promise<void>

deleteTemplate(string, string, string)

Supprime le modèle avec l’ID donné

function deleteTemplate(project: string, team: string, templateId: string): Promise<void>

Paramètres

project: string

ID de projet ou nom du projet

team: string

ID d’équipe ou nom de l’équipe

templateId: string

ID du modèle

Retours

Promise<void>

deleteWorkItem(number, string, boolean)

Supprime l’élément de travail spécifié et l’envoie à la Corbeille, afin qu’il puisse être restauré, si nécessaire. Si vous le souhaitez, si le paramètre destroy a été défini sur true, il détruit définitivement l’élément de travail. AVERTISSEMENT : si le paramètre destroy a la valeur true, les éléments de travail supprimés par cette commande n’iront PAS à la corbeille et il n’existe aucun moyen de les restaurer/récupérer après la suppression. Il est recommandé de NE PAS utiliser ce paramètre. Dans ce cas, utilisez ce paramètre avec une extrême prudence.

function deleteWorkItem(id: number, project?: string, destroy?: boolean): Promise<WorkItemDelete>

Paramètres

id: number

ID de l’élément de travail à supprimer

project: string

ID de projet ou nom du projet

destroy: boolean

Paramètre facultatif, si la valeur est true, l’élément de travail est supprimé définitivement. Remarque : l’action de destruction est PERMANENTE et ne peut pas être annulée.

Retours

Promise<WorkItemDelete>

destroyWorkItem(number, string)

Détruit définitivement l’élément de travail spécifié à partir de la Corbeille. Cette action ne peut pas être annulée.

function destroyWorkItem(id: number, project?: string): Promise<void>

Paramètres

id: number

ID de l’élément de travail à détruire définitivement

project: string

ID de projet ou nom du projet

Retours

Promise<void>

exportWorkItemTypeDefinition(string, string, boolean)

Exporter le type d’élément de travail

function exportWorkItemTypeDefinition(project?: string, type?: string, exportGlobalLists?: boolean): Promise<WorkItemTypeTemplate>

Paramètres

project: string

ID de projet ou nom du projet

type: string

exportGlobalLists: boolean

Retours

Promise<WorkItemTypeTemplate>

getAccountMyWorkData(QueryOption)

INTERNE UNIQUEMENT : UTILISÉ PAR LA PAGE MON TRAVAIL DU COMPTE. Cette opération renvoie les détails des éléments de travail Doing, Done, Suivi et Activity.

function getAccountMyWorkData(queryOption?: QueryOption): Promise<AccountMyWorkResult>

Paramètres

queryOption: QueryOption

Retours

Promise<AccountMyWorkResult>

getAttachmentContent(string, string, string, boolean)

Télécharge une pièce jointe.

function getAttachmentContent(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>

Paramètres

id: string

ID de pièce jointe

project: string

ID de projet ou nom du projet

fileName: string

Nom du fichier.

download: boolean

Si la valeur <est c>true</c> , téléchargez toujours la pièce jointe

Retours

Promise<ArrayBuffer>

getAttachmentZip(string, string, string, boolean)

Télécharge une pièce jointe.

function getAttachmentZip(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>

Paramètres

id: string

ID de pièce jointe

project: string

ID de projet ou nom du projet

fileName: string

Nom du fichier.

download: boolean

Si la valeur <est c>true</c> , téléchargez toujours la pièce jointe

Retours

Promise<ArrayBuffer>

getClassificationNode(string, TreeStructureGroup, string, number)

Obtient le nœud de classification pour un chemin de nœud donné.

function getClassificationNode(project: string, structureGroup: TreeStructureGroup, path?: string, depth?: number): Promise<WorkItemClassificationNode>

Paramètres

project: string

ID de projet ou nom du projet

structureGroup: TreeStructureGroup

Groupe de structure du nœud de classification, de la zone ou de l’itération.

path: string

Chemin du nœud de classification.

depth: number

Profondeur des enfants à extraire.

Retours

Promise<WorkItemClassificationNode>

getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)

Obtient les nœuds de classification racine ou la liste des nœuds de classification pour une liste donnée d’ID de nœuds, pour un projet donné. Si le paramètre ids est fourni, vous obtenez la liste des nœuds de classification pour ces ID. Sinon, vous obtiendrez des nœuds de classification racine pour ce projet.

function getClassificationNodes(project: string, ids: number[], depth?: number, errorPolicy?: ClassificationNodesErrorPolicy): Promise<WorkItemClassificationNode[]>

Paramètres

project: string

ID de projet ou nom du projet

ids: number[]

ID de nœuds de classification d’entiers séparés par des virgules. Elle n’est pas obligatoire si vous souhaitez des nœuds racines.

depth: number

Profondeur des enfants à extraire.

errorPolicy: ClassificationNodesErrorPolicy

Indicateur permettant de gérer les erreurs lors de l’obtention de certains nœuds. Les options possibles sont Échec et Omit.

Retours

Promise<WorkItemClassificationNode[]>

getComment(number, number, string)

Obtient un commentaire pour un élément de travail à la révision spécifiée.

function getComment(id: number, revision: number, project?: string): Promise<WorkItemComment>

Paramètres

id: number

ID de l’élément de travail

revision: number

Révision pour laquelle le commentaire doit être extrait

project: string

ID de projet ou nom du projet

Retours

Promise<WorkItemComment>

getComments(number, string, number, number, CommentSortOrder)

Obtient le nombre spécifié de commentaires pour un élément de travail à partir de la révision spécifiée.

function getComments(id: number, project?: string, fromRevision?: number, top?: number, order?: CommentSortOrder): Promise<WorkItemComments>

Paramètres

id: number

ID de l’élément de travail

project: string

ID de projet ou nom du projet

fromRevision: number

Révision à partir de laquelle les commentaires doivent être extraits (la valeur par défaut est 1)

top: number

Nombre de commentaires à retourner (la valeur par défaut est 200)

order: CommentSortOrder

Croissant ou décroissant par ID de révision (la valeur par défaut est croissant)

Retours

Promise<WorkItemComments>

getDeletedWorkItem(number, string)

Obtient un élément de travail supprimé de la Corbeille.

function getDeletedWorkItem(id: number, project?: string): Promise<WorkItemDelete>

Paramètres

id: number

ID de l’élément de travail à retourner

project: string

ID de projet ou nom du projet

Retours

Promise<WorkItemDelete>

getDeletedWorkItems(number[], string)

Obtient les éléments de travail de la corbeille, dont les ID ont été spécifiés dans les paramètres

function getDeletedWorkItems(ids: number[], project?: string): Promise<WorkItemDeleteReference[]>

Paramètres

ids: number[]

Liste d’ID séparés par des virgules des éléments de travail supprimés à retourner

project: string

ID de projet ou nom du projet

Retours

Promise<WorkItemDeleteReference[]>

getDeletedWorkItemShallowReferences(string)

Obtient une liste des ID et des URL des éléments de travail supprimés dans la Corbeille.

function getDeletedWorkItemShallowReferences(project?: string): Promise<WorkItemDeleteShallowReference[]>

Paramètres

project: string

ID de projet ou nom du projet

Retours

Promise<WorkItemDeleteShallowReference[]>

getField(string, string)

Obtient des informations sur un champ spécifique.

function getField(fieldNameOrRefName: string, project?: string): Promise<WorkItemField>

Paramètres

fieldNameOrRefName: string

Nom simple de champ ou nom de référence

project: string

ID de projet ou nom du projet

Retours

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

Retourne des informations pour tous les champs. Le paramètre ID/nom du projet est facultatif.

function getFields(project?: string, expand?: GetFieldsExpand): Promise<WorkItemField[]>

Paramètres

project: string

ID de projet ou nom du projet

expand: GetFieldsExpand

Utilisez ExtensionFields pour inclure des champs d’extension, sinon excluez-les. Sauf si l’indicateur de fonctionnalité pour ce paramètre est activé, les champs d’extension sont toujours inclus.

Retours

Promise<WorkItemField[]>

getQueries(string, QueryExpand, number, boolean)

Obtient les requêtes racine et leurs enfants

function getQueries(project: string, expand?: QueryExpand, depth?: number, includeDeleted?: boolean): Promise<QueryHierarchyItem[]>

Paramètres

project: string

ID de projet ou nom du projet

expand: QueryExpand

Incluez la chaîne de requête (wiql), les clauses, les colonnes de résultats de requête et les options de tri dans les résultats.

depth: number

Dans le dossier des requêtes, retournez les requêtes et dossiers enfants à cette profondeur.

includeDeleted: boolean

Inclure les requêtes et dossiers supprimés

Retours

Promise<QueryHierarchyItem[]>

getQueriesBatch(QueryBatchGetRequest, string)

Obtient une liste de requêtes par ids (maximum 1000)

function getQueriesBatch(queryGetRequest: QueryBatchGetRequest, project: string): Promise<QueryHierarchyItem[]>

Paramètres

queryGetRequest: QueryBatchGetRequest

project: string

ID de projet ou nom du projet

Retours

Promise<QueryHierarchyItem[]>

getQuery(string, string, QueryExpand, number, boolean, boolean)

Récupère une requête individuelle et ses enfants

function getQuery(project: string, query: string, expand?: QueryExpand, depth?: number, includeDeleted?: boolean, useIsoDateFormat?: boolean): Promise<QueryHierarchyItem>

Paramètres

project: string

ID de projet ou nom du projet

query: string

ID ou chemin d’accès de la requête.

expand: QueryExpand

Incluez la chaîne de requête (wiql), les clauses, les colonnes de résultats de requête et les options de tri dans les résultats.

depth: number

Dans le dossier des requêtes, retournez les requêtes et dossiers enfants à cette profondeur.

includeDeleted: boolean

Inclure les requêtes et dossiers supprimés

useIsoDateFormat: boolean

Les clauses de requête DateTime seront mises en forme à l’aide d’un format conforme à la norme ISO 8601

Retours

Promise<QueryHierarchyItem>

getQueryResultCount(string, string, string, boolean, number)

Obtient les résultats de la requête en fonction de l’ID de requête.

function getQueryResultCount(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<number>

Paramètres

id: string

ID de requête.

project: string

ID de projet ou nom du projet

team: string

ID d’équipe ou nom de l’équipe

timePrecision: boolean

Indique s’il faut ou non utiliser la précision du temps.

top: number

Nombre maximal de résultats à retourner.

Retours

Promise<number>

getRecentActivityData()

Obtient les activités d’élément de travail récentes

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Retours

Promise<AccountRecentActivityWorkItemModel2[]>

getRecentMentions()

INTERNE UNIQUEMENT : UTILISÉ PAR LA PAGE MON TRAVAIL DU COMPTE.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Retours

Promise<AccountRecentMentionWorkItemModel[]>

getRelationType(string)

Obtient la définition du type de relation d’élément de travail.

function getRelationType(relation: string): Promise<WorkItemRelationType>

Paramètres

relation: string

Nom de la relation

Retours

Promise<WorkItemRelationType>

getRelationTypes()

Obtient les types de relation d’élément de travail.

function getRelationTypes(): Promise<WorkItemRelationType[]>

Retours

Promise<WorkItemRelationType[]>

getReportingLinksByLinkType(string, string[], string[], string, Date)

Obtenir un lot de liens d’éléments de travail

function getReportingLinksByLinkType(project?: string, linkTypes?: string[], types?: string[], continuationToken?: string, startDateTime?: Date): Promise<ReportingWorkItemLinksBatch>

Paramètres

project: string

ID de projet ou nom du projet

linkTypes: string[]

Liste de types pour filtrer les résultats sur des types de liens spécifiques. Omettez ce paramètre pour obtenir des liens d’éléments de travail de tous les types de liens.

types: string[]

Liste de types pour filtrer les résultats selon des types d’éléments de travail spécifiques. Omettez ce paramètre pour obtenir des liens d’éléments de travail de tous les types d’éléments de travail.

continuationToken: string

Spécifie le continuationToken à partir duquel démarrer le lot. Omettez ce paramètre pour obtenir le premier lot de liens.

startDateTime: Date

Date/heure à utiliser comme point de départ pour les modifications de lien. Seules les modifications de lien qui se sont produites après cette date/heure seront retournées. Impossible d’utiliser conjointement avec le paramètre « filigrane ».

Retours

Promise<ReportingWorkItemLinksBatch>

getRevision(number, number, string, WorkItemExpand)

Retourne un élément de travail entièrement hydraté pour la révision demandée

function getRevision(id: number, revisionNumber: number, project?: string, expand?: WorkItemExpand): Promise<WorkItem>

Paramètres

id: number

revisionNumber: number

project: string

ID de projet ou nom du projet

expand: WorkItemExpand

Retours

Promise<WorkItem>

getRevisions(number, string, number, number, WorkItemExpand)

Retourne la liste des révisions d’éléments de travail entièrement hydratées, paginées.

function getRevisions(id: number, project?: string, top?: number, skip?: number, expand?: WorkItemExpand): Promise<WorkItem[]>

Paramètres

id: number

project: string

ID de projet ou nom du projet

top: number

skip: number

expand: WorkItemExpand

Retours

Promise<WorkItem[]>

getRootNodes(string, number)

Obtient les nœuds de classification racine sous le projet.

function getRootNodes(project: string, depth?: number): Promise<WorkItemClassificationNode[]>

Paramètres

project: string

ID de projet ou nom du projet

depth: number

Profondeur des enfants à récupérer.

Retours

Promise<WorkItemClassificationNode[]>

getTemplate(string, string, string)

Obtient le modèle avec l’ID spécifié

function getTemplate(project: string, team: string, templateId: string): Promise<WorkItemTemplate>

Paramètres

project: string

ID de projet ou nom du projet

team: string

ID d’équipe ou nom de l’équipe

templateId: string

ID du modèle

Retours

Promise<WorkItemTemplate>

getTemplates(string, string, string)

Obtient le modèle

function getTemplates(project: string, team: string, workitemtypename?: string): Promise<WorkItemTemplateReference[]>

Paramètres

project: string

ID de projet ou nom du projet

team: string

ID d’équipe ou nom de l’équipe

workitemtypename: string

Facultatif, lorsque spécifié retourne des modèles pour un type d’élément de travail donné.

Retours

Promise<WorkItemTemplateReference[]>

getUpdate(number, number, string)

Retourne une mise à jour unique pour un élément de travail

function getUpdate(id: number, updateNumber: number, project?: string): Promise<WorkItemUpdate>

Paramètres

id: number

updateNumber: number

project: string

ID de projet ou nom du projet

Retours

Promise<WorkItemUpdate>

getUpdates(number, string, number, number)

Retourne les deltas entre les révisions d’élément de travail

function getUpdates(id: number, project?: string, top?: number, skip?: number): Promise<WorkItemUpdate[]>

Paramètres

id: number

project: string

ID de projet ou nom du projet

top: number

skip: number

Retours

Promise<WorkItemUpdate[]>

getWorkArtifactLinkTypes()

Obtenez la liste des types de liens d’artefact sortants de suivi des éléments de travail.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

Retours

Promise<WorkArtifactLink[]>

getWorkItem(number, string, string[], Date, WorkItemExpand)

Retourne un seul élément de travail.

function getWorkItem(id: number, project?: string, fields?: string[], asOf?: Date, expand?: WorkItemExpand): Promise<WorkItem>

Paramètres

id: number

ID de l’élément de travail

project: string

ID de projet ou nom du projet

fields: string[]

Liste séparée par des virgules des champs demandés

asOf: Date

Chaîne d’heure de date UTC AsOf

expand: WorkItemExpand

Paramètres de développement pour les attributs d’élément de travail. Les options possibles sont { None, Relations, Fields, Links, All }.

Retours

Promise<WorkItem>

getWorkItemIconJson(string, string, number)

Obtenez une icône d’élément de travail en fonction du nom convivial et de la couleur de l’icône.

function getWorkItemIconJson(icon: string, color?: string, v?: number): Promise<WorkItemIcon>

Paramètres

icon: string

Nom de l’icône

color: string

Couleur hexadécimal à 6 chiffres de l’icône

v: number

Version de l’icône (utilisée uniquement pour l’invalidation du cache)

Retours

Promise<WorkItemIcon>

getWorkItemIcons()

Obtenez la liste de toutes les icônes d’élément de travail.

function getWorkItemIcons(): Promise<WorkItemIcon[]>

Retours

Promise<WorkItemIcon[]>

getWorkItemIconSvg(string, string, number)

Obtenez une icône d’élément de travail en fonction du nom convivial et de la couleur de l’icône.

function getWorkItemIconSvg(icon: string, color?: string, v?: number): Promise<any>

Paramètres

icon: string

Nom de l’icône

color: string

Couleur hexadécimal à 6 chiffres de l’icône

v: number

Version de l’icône (utilisée uniquement pour l’invalidation du cache)

Retours

Promise<any>

getWorkItemIconXaml(string, string, number)

Obtenez une icône d’élément de travail en fonction du nom convivial et de la couleur de l’icône.

function getWorkItemIconXaml(icon: string, color?: string, v?: number): Promise<any>

Paramètres

icon: string

Nom de l’icône

color: string

Couleur hexadécimal à 6 chiffres de l’icône

v: number

Version de l’icône (utilisée uniquement pour l’invalidation du cache)

Retours

Promise<any>

getWorkItemNextStatesOnCheckinAction(number[], string)

Retourne l’état suivant sur les ID d’élément de travail donnés.

function getWorkItemNextStatesOnCheckinAction(ids: number[], action?: string): Promise<WorkItemNextStateOnTransition[]>

Paramètres

ids: number[]

liste des ID d’élément de travail

action: string

actions possibles. Prend actuellement uniquement en charge l’archivage

Retours

Promise<WorkItemNextStateOnTransition[]>

getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)

Retourne une liste d’éléments de travail (maximum 200)

function getWorkItems(ids: number[], project?: string, fields?: string[], asOf?: Date, expand?: WorkItemExpand, errorPolicy?: WorkItemErrorPolicy): Promise<WorkItem[]>

Paramètres

ids: number[]

Liste séparée par des virgules des ID d’élément de travail demandés. (Maximum 200 ids autorisés).

project: string

ID de projet ou nom du projet

fields: string[]

Liste séparée par des virgules des champs demandés

asOf: Date

Chaîne d’heure de date UTC AsOf

expand: WorkItemExpand

Paramètres de développement pour les attributs d’élément de travail. Les options possibles sont { None, Relations, Fields, Links, All }.

errorPolicy: WorkItemErrorPolicy

Indicateur permettant de contrôler la stratégie d’erreur dans une demande d’obtention en bloc d’éléments de travail. Les options possibles sont {Fail, Omit}.

Retours

Promise<WorkItem[]>

getWorkItemsBatch(WorkItemBatchGetRequest, string)

Obtient des éléments de travail pour une liste d’ID d’élément de travail (maximum 200)

function getWorkItemsBatch(workItemGetRequest: WorkItemBatchGetRequest, project?: string): Promise<WorkItem[]>

Paramètres

workItemGetRequest: WorkItemBatchGetRequest

project: string

ID de projet ou nom du projet

Retours

Promise<WorkItem[]>

getWorkItemStateColors(string[])

INTERNE UNIQUEMENT : il sera utilisé pour l’expérience professionnelle de Mon compte. Obtenir la couleur d’état du type d’élément de travail pour plusieurs projets

function getWorkItemStateColors(projectNames: string[]): Promise<ProjectWorkItemStateColors[]>

Paramètres

projectNames: string[]

Retours

Promise<ProjectWorkItemStateColors[]>

getWorkItemTemplate(string, string, string, Date, WorkItemExpand)

Retourne un seul élément de travail à partir d’un modèle.

function getWorkItemTemplate(project: string, type: string, fields?: string, asOf?: Date, expand?: WorkItemExpand): Promise<WorkItem>

Paramètres

project: string

ID de projet ou nom du projet

type: string

Nom du type d’élément de travail

fields: string

Liste des champs demandés séparés par des virgules

asOf: Date

Chaîne d’heure de date UTC AsOf

expand: WorkItemExpand

Paramètres de développement pour les attributs d’élément de travail. Les options possibles sont { None, Relations, Fields, Links, All }.

Retours

Promise<WorkItem>

getWorkItemType(string, string)

Retourne une définition de type d’élément de travail.

function getWorkItemType(project: string, type: string): Promise<WorkItemType>

Paramètres

project: string

ID de projet ou nom du projet

type: string

Nom du type d’élément de travail

Retours

Promise<WorkItemType>

getWorkItemTypeCategories(string)

Obtenir toutes les catégories de type d’élément de travail.

function getWorkItemTypeCategories(project: string): Promise<WorkItemTypeCategory[]>

Paramètres

project: string

ID de projet ou nom du projet

Retours

Promise<WorkItemTypeCategory[]>

getWorkItemTypeCategory(string, string)

Obtenir une catégorie de type d’élément de travail spécifique par nom.

function getWorkItemTypeCategory(project: string, category: string): Promise<WorkItemTypeCategory>

Paramètres

project: string

ID de projet ou nom du projet

category: string

Nom de la catégorie

Retours

Promise<WorkItemTypeCategory>

getWorkItemTypeColorAndIcons(string[])

INTERNE UNIQUEMENT : il est utilisé pour les fournisseurs de couleurs et d’icônes. Obtenir la couleur de type wit pour plusieurs projets

function getWorkItemTypeColorAndIcons(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>

Paramètres

projectNames: string[]

Retours

Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>

getWorkItemTypeColors(string[])

INTERNE UNIQUEMENT : il sera utilisé pour l’expérience professionnelle De mon compte. Obtenir la couleur de type wit pour plusieurs projets

function getWorkItemTypeColors(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColor[] }[]>

Paramètres

projectNames: string[]

Retours

Promise<{ key: string, value: WorkItemTypeColor[] }[]>

getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)

Obtenir la liste des champs d’un type d’élément de travail avec des références détaillées.

function getWorkItemTypeFieldsWithReferences(project: string, type: string, expand?: WorkItemTypeFieldsExpandLevel): Promise<WorkItemTypeFieldWithReferences[]>

Paramètres

project: string

ID de projet ou nom du projet

type: string

Type d’élément de travail.

expand: WorkItemTypeFieldsExpandLevel

Développez le niveau pour la réponse de l’API. Propriétés : pour inclure allowedvalues, valeur par défaut, isRequired, etc. dans le cadre de la réponse ; Aucun : pour ignorer ces propriétés.

Retours

Promise<WorkItemTypeFieldWithReferences[]>

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

Obtenir un champ pour un type d’élément de travail avec des références détaillées.

function getWorkItemTypeFieldWithReferences(project: string, type: string, field: string, expand?: WorkItemTypeFieldsExpandLevel): Promise<WorkItemTypeFieldWithReferences>

Paramètres

project: string

ID de projet ou nom du projet

type: string

Type d’élément de travail.

field: string

expand: WorkItemTypeFieldsExpandLevel

Retours

Promise<WorkItemTypeFieldWithReferences>

getWorkItemTypes(string)

Retourne la liste des types d’éléments de travail

function getWorkItemTypes(project: string): Promise<WorkItemType[]>

Paramètres

project: string

ID de projet ou nom du projet

Retours

Promise<WorkItemType[]>

getWorkItemTypeStates(string, string)

Retourne les noms d’état et les couleurs d’un type d’élément de travail.

function getWorkItemTypeStates(project: string, type: string): Promise<WorkItemStateColor[]>

Paramètres

project: string

ID de projet ou nom du projet

type: string

Nom de l’état

Retours

Promise<WorkItemStateColor[]>

queryById(string, string, string, boolean, number)

Obtient les résultats de la requête en fonction de l’ID de requête.

function queryById(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemQueryResult>

Paramètres

id: string

ID de requête.

project: string

ID de projet ou nom du projet

team: string

ID d’équipe ou nom de l’équipe

timePrecision: boolean

Indique s’il faut utiliser ou non la précision temporelle.

top: number

Nombre maximal de résultats à retourner.

Retours

Promise<WorkItemQueryResult>

queryByWiql(Wiql, string, string, boolean, number)

Obtient les résultats de la requête en fonction de son WIQL.

function queryByWiql(wiql: Wiql, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemQueryResult>

Paramètres

wiql: Wiql

Requête contenant le WIQL.

project: string

ID de projet ou nom du projet

team: string

ID d’équipe ou nom de l’équipe

timePrecision: boolean

Indique s’il faut utiliser ou non la précision temporelle.

top: number

Nombre maximal de résultats à retourner.

Retours

Promise<WorkItemQueryResult>

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

Requêtes éléments de travail liés à une liste donnée d’URI d’artefact.

function queryWorkItemsForArtifactUris(artifactUriQuery: ArtifactUriQuery, project?: string): Promise<ArtifactUriQueryResult>

Paramètres

artifactUriQuery: ArtifactUriQuery

Définit une liste d’URI d’artefact pour interroger des éléments de travail.

project: string

ID de projet ou nom du projet

Retours

Promise<ArtifactUriQueryResult>

readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)

Obtenir un lot de révisions d’éléments de travail avec la possibilité d’inclure des éléments supprimés

function readReportingRevisionsGet(project?: string, fields?: string[], types?: string[], continuationToken?: string, startDateTime?: Date, includeIdentityRef?: boolean, includeDeleted?: boolean, includeTagRef?: boolean, includeLatestOnly?: boolean, expand?: ReportingRevisionsExpand, includeDiscussionChangesOnly?: boolean, maxPageSize?: number): Promise<ReportingWorkItemRevisionsBatch>

Paramètres

project: string

ID de projet ou nom du projet

fields: string[]

Liste de champs à retourner dans les révisions d’éléments de travail. Omettez ce paramètre pour obtenir tous les champs pouvant être rapportés.

types: string[]

Liste de types pour filtrer les résultats sur des types d’éléments de travail spécifiques. Omettez ce paramètre pour obtenir les révisions d’éléments de travail de tous les types d’éléments de travail.

continuationToken: string

Spécifie le filigrane à partir duquel démarrer le lot. Omettez ce paramètre pour obtenir le premier lot de révisions.

startDateTime: Date

Date/heure à utiliser comme point de départ pour les révisions, toutes les révisions se produisent après cette date/heure. Ne peut pas être utilisé conjointement avec le paramètre « filigrane ».

includeIdentityRef: boolean

Retourne une référence d’identité au lieu d’une valeur de chaîne pour les champs d’identité.

includeDeleted: boolean

Spécifiez si l’élément supprimé doit être retourné.

includeTagRef: boolean

Spécifiez si les objets de balise doivent être retournés pour le champ System.Tags.

includeLatestOnly: boolean

Retourner uniquement les dernières révisions des éléments de travail, en ignorant toutes les révisions historiques

expand: ReportingRevisionsExpand

Retourner tous les champs dans les révisions d’élément de travail, y compris les champs de texte long qui ne sont pas retournés par défaut

includeDiscussionChangesOnly: boolean

Retourner uniquement les révisions des éléments de travail, où seul le champ d’historique a été modifié

maxPageSize: number

Nombre maximal de résultats à retourner dans ce lot

Retours

Promise<ReportingWorkItemRevisionsBatch>

readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)

Obtenir un lot de révisions d’élément de travail. Cette requête peut être utilisée si votre liste de champs est suffisamment grande pour qu’elle puisse exécuter l’URL au-dessus de la limite de longueur.

function readReportingRevisionsPost(filter: ReportingWorkItemRevisionsFilter, project?: string, continuationToken?: string, startDateTime?: Date, expand?: ReportingRevisionsExpand): Promise<ReportingWorkItemRevisionsBatch>

Paramètres

filter: ReportingWorkItemRevisionsFilter

Objet qui contient les paramètres de demande : filtre de champ, filtre de type, format d’identité

project: string

ID de projet ou nom du projet

continuationToken: string

Spécifie le filigrane à partir duquel démarrer le lot. Omettez ce paramètre pour obtenir le premier lot de révisions.

startDateTime: Date

expand: ReportingRevisionsExpand

Retours

Promise<ReportingWorkItemRevisionsBatch>

replaceTemplate(WorkItemTemplate, string, string, string)

Remplacer le contenu du modèle

function replaceTemplate(templateContent: WorkItemTemplate, project: string, team: string, templateId: string): Promise<WorkItemTemplate>

Paramètres

templateContent: WorkItemTemplate

Contenu du modèle à remplacer par

project: string

ID de projet ou nom du projet

team: string

ID d’équipe ou nom de l’équipe

templateId: string

ID du modèle

Retours

Promise<WorkItemTemplate>

restoreWorkItem(WorkItemDeleteUpdate, number, string)

Restaure l’élément de travail supprimé de la Corbeille.

function restoreWorkItem(payload: WorkItemDeleteUpdate, id: number, project?: string): Promise<WorkItemDelete>

Paramètres

payload: WorkItemDeleteUpdate

Paylod avec des instructions pour mettre à jour l’indicateur IsDeleted sur false

id: number

ID de l’élément de travail à restaurer

project: string

ID de projet ou nom du projet

Retours

Promise<WorkItemDelete>

searchQueries(string, string, number, QueryExpand, boolean)

Recherche toutes les requêtes à laquelle l’utilisateur a accès dans le projet actuel

function searchQueries(project: string, filter: string, top?: number, expand?: QueryExpand, includeDeleted?: boolean): Promise<QueryHierarchyItemsResult>

Paramètres

project: string

ID de projet ou nom du projet

filter: string

Texte avec lequel filtrer les requêtes.

top: number

Nombre de requêtes à retourner (la valeur par défaut est 50 et la valeur maximale est 200).

expand: QueryExpand

includeDeleted: boolean

Inclure des requêtes et des dossiers supprimés

Retours

Promise<QueryHierarchyItemsResult>

sendMail(SendMailBody, string)

Méthode RESTful pour envoyer des messages pour les éléments de travail sélectionnés/interrogés.

function sendMail(body: SendMailBody, project?: string): Promise<void>

Paramètres

body: SendMailBody

project: string

ID de projet ou nom du projet

Retours

Promise<void>

updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Mettre à jour un nœud de classification existant.

function updateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>

Paramètres

postedNode: WorkItemClassificationNode

Nœud à créer ou à mettre à jour.

project: string

ID de projet ou nom du projet

structureGroup: TreeStructureGroup

Groupe de structure du nœud de classification, de la zone ou de l’itération.

path: string

Chemin du nœud de classification.

Retours

Promise<WorkItemClassificationNode>

updateField(UpdateWorkItemField, string, string)

Mettre à jour un champ.

function updateField(payload: UpdateWorkItemField, fieldNameOrRefName: string, project?: string): Promise<WorkItemField>

Paramètres

payload: UpdateWorkItemField

La charge utile contient la valeur souhaitée des propriétés du champ

fieldNameOrRefName: string

Nom/nom de référence du champ à mettre à jour

project: string

ID de projet ou nom du projet

Retours

Promise<WorkItemField>

updateQuery(QueryHierarchyItem, string, string, boolean)

Mettez à jour une requête ou un dossier. Cela vous permet de mettre à jour, de renommer et de déplacer des requêtes et des dossiers.

function updateQuery(queryUpdate: QueryHierarchyItem, project: string, query: string, undeleteDescendants?: boolean): Promise<QueryHierarchyItem>

Paramètres

queryUpdate: QueryHierarchyItem

Requête à mettre à jour.

project: string

ID de projet ou nom du projet

query: string

ID ou chemin d’accès de la requête à mettre à jour.

undeleteDescendants: boolean

Annulez la suppression des enfants de ce dossier. Il est important de noter que cela ne rétablit pas les modifications d’autorisation précédemment appliquées aux descendants.

Retours

Promise<QueryHierarchyItem>

updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)

Mises à jour un seul élément de travail.

function updateWorkItem(document: JsonPatchDocument, id: number, project?: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemExpand): Promise<WorkItem>

Paramètres

document: JsonPatchDocument

Document json patch représentant la mise à jour

id: number

ID de l’élément de travail à mettre à jour

project: string

ID de projet ou nom du projet

validateOnly: boolean

Indiquez si vous souhaitez uniquement valider les modifications sans enregistrer l’élément de travail

bypassRules: boolean

N’appliquez pas les règles de type d’élément de travail sur cette mise à jour

suppressNotifications: boolean

Ne pas déclencher de notifications pour cette modification

expand: WorkItemExpand

Paramètres de développement pour les attributs d’élément de travail. Les options possibles sont { None, Relations, Fields, Links, All }.

Retours

Promise<WorkItem>

updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)

Ajouter/mettre à jour un type d’élément de travail

function updateWorkItemTypeDefinition(updateModel: WorkItemTypeTemplateUpdateModel, project?: string): Promise<ProvisioningResult>

Paramètres

updateModel: WorkItemTypeTemplateUpdateModel

project: string

ID de projet ou nom du projet

Retours

Promise<ProvisioningResult>

Partager via

WorkItemTrackingRestClient class

Constructeurs

Propriétés

Méthodes

Détails du constructeur

WorkItemTrackingRestClient(IVssRestClientOptions)

Paramètres

Détails de la propriété

RESOURCE_AREA_ID

Valeur de propriété

Détails de la méthode

createAttachment(any, string, string, string, string)

Paramètres

Retours

createField(WorkItemField, string)

Paramètres

Retours

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Paramètres

Retours

createQuery(QueryHierarchyItem, string, string, boolean)

Paramètres

Retours

createTemplate(WorkItemTemplate, string, string)

Paramètres

Retours

createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)

Paramètres

Retours

deleteClassificationNode(string, TreeStructureGroup, string, number)

Paramètres

Retours

deleteField(string, string)

Paramètres

Retours

deleteQuery(string, string)

Paramètres

Retours

deleteTemplate(string, string, string)

Paramètres

Retours

deleteWorkItem(number, string, boolean)

Paramètres

Retours

destroyWorkItem(number, string)

Paramètres

Retours

exportWorkItemTypeDefinition(string, string, boolean)

Paramètres

Retours

getAccountMyWorkData(QueryOption)

Paramètres

Retours

getAttachmentContent(string, string, string, boolean)

Paramètres

Retours

getAttachmentZip(string, string, string, boolean)

Paramètres

Retours

getClassificationNode(string, TreeStructureGroup, string, number)

Paramètres

Retours

getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)

Paramètres

Retours

getComment(number, number, string)

Paramètres

Retours

getComments(number, string, number, number, CommentSortOrder)

Paramètres

Retours

getDeletedWorkItem(number, string)

Paramètres

Retours

getDeletedWorkItems(number[], string)

Paramètres

Retours

getDeletedWorkItemShallowReferences(string)

Paramètres