WorkItemTrackingRestClient class

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

Paramètres

static RESOURCE_AREA_ID: string

Valeur de propriété

Charge une pièce jointe.

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

Paramètres

Retours

Créez un champ.

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

Paramètres

Retours

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

Retours

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

Retours

Crée un modèle

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

Paramètres

Retours

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

Retours

Supprimer un nœud de classification existant.

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

Paramètres

Retours

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

Retours

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

Retours

Supprime le modèle avec l’ID donné

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

Paramètres

Retours

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

Retours

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

Retours

Exporter le type d’élément de travail

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

Paramètres

Retours

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

Retours

Télécharge une pièce jointe.

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

Paramètres

Retours

Télécharge une pièce jointe.

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

Paramètres

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

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

Paramètres

Retours

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

Retours

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

Retours

Obtient des informations sur un champ spécifique.

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

Paramètres

Retours

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

Retours

Obtient les requêtes racine et leurs enfants

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

Paramètres

Retours

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

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

Paramètres

Retours

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

Retours

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

Retours

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

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Retours

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

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Retours

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

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

Paramètres

Retours

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

function getRelationTypes(): Promise<WorkItemRelationType[]>

Retours

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

Retours

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

Retours

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

Retours

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

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

Paramètres

Retours

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

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

Paramètres

Retours

Obtient le modèle

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

Paramètres

Retours

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

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

Paramètres

Retours

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

Retours

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

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

Retours

Retourne un seul élément de travail.

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

Paramètres

Retours

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

Retours

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

function getWorkItemIcons(): Promise<WorkItemIcon[]>

Retours

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

Retours

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

Retours

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

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

Paramètres

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

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

Paramètres

Retours

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

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

Paramètres

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

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

Paramètres

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

Retours

Remplacer le contenu du modèle

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

Paramètres

Retours

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

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

Paramètres

Retours

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

Retours

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

Retours

Mettre à jour un nœud de classification existant.

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

Paramètres

Retours

Mettre à jour un champ.

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

Paramètres

Retours

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

Retours

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

Retours

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

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

Paramètres

Retours