WorkItemTrackingRestClient class

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

Parameter

static RESOURCE_AREA_ID: string

Eigenschaftswert

Lädt eine Anlage hoch.

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

Parameter

Gibt zurück

Erstellen Sie ein neues Feld.

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

Parameter

Gibt zurück

Erstellen Sie einen neuen, oder aktualisieren Sie einen vorhandenen Klassifizierungsknoten.

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

Parameter

Gibt zurück

Erstellt eine Abfrage oder verschiebt eine Abfrage.

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

Parameter

Gibt zurück

Erstellt eine Vorlage

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

Parameter

Gibt zurück

Erstellt ein einzelnes Arbeitselement.

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

Parameter

Gibt zurück

Löschen Sie einen vorhandenen Klassifizierungsknoten.

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

Parameter

Gibt zurück

Löscht das Feld. Informationen zum Wiederherstellen eines abgelegten Vorgangs finden Sie unter "Feld aktualisieren"-API.

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

Parameter

Gibt zurück

Löschen Sie eine Abfrage oder einen Ordner. Dadurch werden alle Berechtigungsänderungen für die gelöschte Abfrage oder den gelöschten Ordner und alle untergeordneten Elemente gelöscht, wenn es sich um einen Ordner handelt. Es ist wichtig zu beachten, dass die gelöschten Berechtigungsänderungen nicht wiederhergestellt werden können, wenn sie die Abfrage oder den Ordner wiederherstellen.

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

Parameter

Gibt zurück

Löscht die Vorlage mit der angegebenen ID.

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

Parameter

Gibt zurück

Löscht das angegebene Arbeitselement und sendet es an den Papierkorb, damit es bei Bedarf wiederhergestellt werden kann. Wenn der Destroy-Parameter auf true festgelegt wurde, wird das Arbeitselement optional dauerhaft zerstört. WARNUNG: Wenn der Destroy-Parameter auf true festgelegt ist, werden mit diesem Befehl gelöschte Arbeitselemente NICHT in den Papierkorb verschoben, und es gibt keine Möglichkeit, sie nach dem Löschen wiederherzustellen/wiederherzustellen. Es wird empfohlen, diesen Parameter NICHT zu verwenden. Wenn Sie dies tun, verwenden Sie diesen Parameter mit äußerster Vorsicht.

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

Parameter

Gibt zurück

Zerstört das angegebene Arbeitselement dauerhaft aus dem Papierkorb. Diese Aktion kann nicht rückgängig werden.

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

Parameter

Gibt zurück

Exportieren des Arbeitselementtyps

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

Parameter

Gibt zurück

NUR INTERN: WIRD VOM KONTO MEINE ARBEITSSEITE VERWENDET. Dadurch werden Die Arbeitselemente "Doing", "Done", "Follows" und "Activity" zurückgegeben.

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

Parameter

Gibt zurück

Lädt eine Anlage herunter.

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

Parameter

Gibt zurück

Lädt eine Anlage herunter.

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

Parameter

Gibt zurück

Ruft den Klassifizierungsknoten für einen angegebenen Knotenpfad ab.

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

Parameter

Gibt zurück

Ruft Stammklassifizierungsknoten oder Liste von Klassifizierungsknoten für eine bestimmte Liste von Knoten-IDs für ein bestimmtes Projekt ab. Falls der Ids-Parameter angegeben wird, erhalten Sie eine Liste der Klassifizierungsknoten für diese IDs. Andernfalls erhalten Sie Stammklassifizierungsknoten für dieses Projekt.

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

Parameter

Gibt zurück

Ruft einen Kommentar für ein Arbeitselement bei der angegebenen Revision ab.

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

Parameter

Gibt zurück

Ruft die angegebene Anzahl von Kommentaren für ein Arbeitselement aus der angegebenen Revision ab.

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

Parameter

Gibt zurück

Ruft ein gelöschtes Arbeitselement aus dem Papierkorb ab.

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

Parameter

Gibt zurück

Ruft die Arbeitselemente aus dem Papierkorb ab, deren IDs in den Parametern angegeben wurden

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

Parameter

Gibt zurück

Ruft eine Liste der IDs und der URLs der gelöschten Arbeitselemente im Papierkorb ab.

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

Parameter

Gibt zurück

Ruft Informationen zu einem bestimmten Feld ab.

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

Parameter

Gibt zurück

Gibt Informationen für alle Felder zurück. Der Projekt-ID/Name-Parameter ist optional.

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

Parameter

Gibt zurück

Ruft die Stammabfragen und ihre untergeordneten Elemente ab.

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

Parameter

Gibt zurück

Ruft eine Liste von Abfragen nach IDs ab (Maximal 1000)

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

Parameter

Gibt zurück

Ruft eine einzelne Abfrage und ihre untergeordneten Elemente ab.

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

Parameter

Gibt zurück

Ruft die Ergebnisse der Abfrage unter Berücksichtigung der Abfrage-ID ab.

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

Parameter

Gibt zurück

Ruft die zuletzt verwendeten Arbeitselementaktivitäten ab.

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Gibt zurück

NUR INTERN: WIRD VOM KONTO MEINE ARBEITSSEITE VERWENDET.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Gibt zurück

Ruft die Definition des Arbeitselementbeziehungstyps ab.

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

Parameter

Gibt zurück

Ruft die Arbeitselementbeziehungstypen ab.

function getRelationTypes(): Promise<WorkItemRelationType[]>

Gibt zurück

Abrufen eines Batches von Arbeitselementlinks

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

Parameter

Gibt zurück

Gibt ein vollständig aktiviertes Arbeitselement für die angeforderte Revision zurück.

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

Parameter

Gibt zurück

Gibt die Liste der vollständig aktivierten Überarbeitungen von Arbeitselementen (paged) zurück.

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

Parameter

Gibt zurück

Ruft Stammklassifizierungsknoten unter dem Projekt ab.

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

Parameter

Gibt zurück

Ruft die Vorlage mit der angegebenen ID ab.

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

Parameter

Gibt zurück

Ruft eine Vorlage ab.

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

Parameter

Gibt zurück

Gibt ein einzelnes Update für ein Arbeitselement zurück.

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

Parameter

Gibt zurück

Gibt die Deltas zwischen Überarbeitungen von Arbeitselementen zurück.

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

Parameter

Gibt zurück

Rufen Sie die Liste der Nachverfolgung ausgehender Artefaktlinktypen für Arbeitselemente ab.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

Gibt zurück

Gibt ein einzelnes Arbeitselement zurück.

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

Parameter

Gibt zurück

Rufen Sie ein Arbeitselementsymbol unter Angabe des Anzeigenamens und der Symbolfarbe ab.

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

Parameter

Gibt zurück

Ruft eine Liste aller Arbeitselementsymbole ab.

function getWorkItemIcons(): Promise<WorkItemIcon[]>

Gibt zurück

Rufen Sie ein Arbeitselementsymbol unter Angabe des Anzeigenamens und der Symbolfarbe ab.

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

Parameter

Gibt zurück

Rufen Sie ein Arbeitselementsymbol unter Angabe des Anzeigenamens und der Symbolfarbe ab.

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

Parameter

Gibt zurück

Gibt den nächsten Zustand für die angegebenen Arbeitselement-IDs zurück.

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

Parameter

Gibt zurück

Gibt eine Liste von Arbeitselementen zurück (maximal 200)

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

Parameter

Gibt zurück

Ruft Arbeitselemente für eine Liste von Arbeitselement-IDs ab (Maximal 200)

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

Parameter

Gibt zurück

NUR INTERN: Es wird für die Arbeitserfahrung "Mein Konto" verwendet. Abrufen der Zustandsfarbe des Arbeitselementtyps für mehrere Projekte

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

Parameter

Gibt zurück

Gibt ein einzelnes Arbeitselement aus einer Vorlage zurück.

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

Parameter

Gibt zurück

Gibt eine Arbeitselementtypdefinition zurück.

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

Parameter

Gibt zurück

Ruft alle Kategorien des Arbeitselementtyps ab.

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

Parameter

Gibt zurück

Rufen Sie eine bestimmte Arbeitselementtypkategorie nach Name ab.

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

Parameter

Gibt zurück

NUR INTERN: Es wird für Farb- und Symbolanbieter verwendet. Abrufen der Wit-Typfarbe für mehrere Projekte

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

Parameter

Gibt zurück

NUR INTERN: Es wird für die Arbeitserfahrung "Mein Konto" verwendet. Abrufen der Wit-Typfarbe für mehrere Projekte

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

Parameter

Gibt zurück

Ruft eine Liste von Feldern für einen Arbeitselementtyp mit detaillierten Verweisen ab.

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

Parameter

Gibt zurück

Ruft ein Feld für einen Arbeitselementtyp mit detaillierten Verweisen ab.

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

Parameter

Gibt zurück

Gibt die Liste der Arbeitselementtypen zurück.

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

Parameter

Gibt zurück

Gibt die Zustandsnamen und Farben für einen Arbeitselementtyp zurück.

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

Parameter

Gibt zurück

Ruft die Ergebnisse der Abfrage unter Berücksichtigung der Abfrage-ID ab.

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

Parameter

Gibt zurück

Ruft die Ergebnisse der Abfrage ab, die ihrem WIQL gegeben ist.

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

Parameter

Gibt zurück

Fragt Arbeitselemente ab, die mit einer bestimmten Liste von Artefakt-URI verknüpft sind.

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

Parameter

Gibt zurück

Abrufen eines Batches von Überarbeitungen von Arbeitselementen mit der Option zum Einschließen gelöschter Elemente

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>

Parameter

Gibt zurück

Ruft einen Batch von Überarbeitungen von Arbeitselementen ab. Diese Anforderung kann verwendet werden, wenn Ihre Liste von Feldern groß genug ist, damit die URL über die Längenbegrenzung ausgeführt werden kann.

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

Parameter

Gibt zurück

Ersetzen von Vorlageninhalten

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

Parameter

Gibt zurück

Stellt das gelöschte Arbeitselement aus dem Papierkorb wieder her.

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

Parameter

Gibt zurück

Durchsucht alle Abfragen, auf die der Benutzer im aktuellen Projekt Zugriff hat

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

Parameter

Gibt zurück

RESTful-Methode zum Senden von E-Mails für ausgewählte/abgefragte Arbeitselemente.

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

Parameter

Gibt zurück

Aktualisieren sie einen vorhandenen Klassifizierungsknoten.

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

Parameter

Gibt zurück

Aktualisieren sie ein Feld.

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

Parameter

Gibt zurück

Aktualisieren sie eine Abfrage oder einen Ordner. Dadurch können Sie Abfragen und Ordner aktualisieren, umbenennen und verschieben.

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

Parameter

Gibt zurück

Updates ein einzelnes Arbeitselement.

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

Parameter

Gibt zurück

Hinzufügen/Aktualisieren eines Arbeitselementtyps

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

Parameter

Gibt zurück