WorkItemTrackingRestClient class

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

Parameter

static RESOURCE_AREA_ID: string

Eigenschaftswert

Lädt einen Anhang 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 Klassifizierungsknoten oder aktualisieren Sie einen vorhandenen.

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 eine einzelne Arbeitsaufgabe.

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 einer Datei 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 sowie alle zugehörigen Nachkommen 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 die Abfrage oder der Ordner wiederhergestellt wird.

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 die angegebene Arbeitsaufgabe und sendet sie an den Papierkorb, damit sie bei Bedarf wiederhergestellt werden kann. Wenn der destroy-Parameter optional auf true festgelegt wurde, wird die Arbeitsaufgabe dauerhaft gelöscht. WARNUNG: Wenn der destroy-Parameter auf true festgelegt ist, werden Arbeitselemente, die mit diesem Befehl gelöscht wurden, NICHT in den Papierkorb verschoben, und es gibt keine Möglichkeit, sie nach dem Löschen wiederherzustellen. Es wird empfohlen, diesen Parameter NICHT zu verwenden. Wenn Sie dies tun, verwenden Sie diesen Parameter bitte mit äußerster Vorsicht.

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

Parameter

Gibt zurück

Löscht die angegebene Arbeitsaufgabe dauerhaft aus dem Papierkorb. Diese Aktion kann nicht rückgängig gemacht werden.

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

Parameter

Gibt zurück

Exportieren des Arbeitsaufgabentyps

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

Parameter

Gibt zurück

NUR INTERN: WIRD VON DER SEITE "MEINE ARBEIT" DES KONTOS VERWENDET. Dadurch werden Details zu den Arbeitsaufgaben "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 bestimmten Knotenpfad ab.

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

Parameter

Gibt zurück

Ruft Stammklassifizierungsknoten oder eine 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 eine Arbeitsaufgabe 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 eine Arbeitsaufgabe aus der angegebenen Revision ab.

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

Parameter

Gibt zurück

Ruft eine gelöschte Arbeitsaufgabe aus dem Papierkorb ab.

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

Parameter

Gibt zurück

Ruft die Workitems 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 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 Parameter Projekt-ID/Name 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 der 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 mit der Abfrage-ID ab.

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

Parameter

Gibt zurück

Ruft die letzten Arbeitsaufgabenaktivitäten ab

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Gibt zurück

NUR INTERN: WIRD VON DER SEITE "MEINE ARBEIT" DES KONTOS VERWENDET.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Gibt zurück

Ruft die Definition des Beziehungstyps für Arbeitsaufgaben ab.

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

Parameter

Gibt zurück

Ruft die Beziehungstypen der Arbeitsaufgabe 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 eine vollständig hydratisierte Arbeitsaufgabe 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 Arbeitsaufgabenrevisionen zurück, ausgelagert.

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 die Vorlage ab

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

Parameter

Gibt zurück

Gibt eine einzelne Aktualisierung für eine Arbeitsaufgabe zurück

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

Parameter

Gibt zurück

Gibt die Deltas zwischen Arbeitsaufgabenrevisionen zurück

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

Parameter

Gibt zurück

Rufen Sie die Liste der Linktypen für ausgehende Artefakte zum Nachverfolgen von Arbeitselementen ab.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

Gibt zurück

Gibt eine einzelne Arbeitsaufgabe zurück.

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

Parameter

Gibt zurück

Rufen Sie ein Arbeitselementsymbol ab, das dem Anzeigenamen und der Symbolfarbe zugewiesen wird.

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

Parameter

Gibt zurück

Rufen Sie eine Liste aller Arbeitselementsymbole ab.

function getWorkItemIcons(): Promise<WorkItemIcon[]>

Gibt zurück

Rufen Sie ein Arbeitselementsymbol ab, das dem Anzeigenamen und der Symbolfarbe zugewiesen wird.

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

Parameter

Gibt zurück

Rufen Sie ein Arbeitselementsymbol ab, das dem Anzeigenamen und der Symbolfarbe zugewiesen wird.

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

Parameter

Gibt zurück

Gibt den nächsten Zustand für die angegebenen Arbeitsaufgaben-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 Arbeitsaufgaben-IDs ab (maximal 200)

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

Parameter

Gibt zurück

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

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

Parameter

Gibt zurück

Gibt eine einzelne Arbeitsaufgabe 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 Definition des Arbeitsaufgabentyps zurück.

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

Parameter

Gibt zurück

Rufen Sie alle Arbeitsaufgabentypkategorien ab.

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

Parameter

Gibt zurück

Rufen Sie eine bestimmte Kategorie des Arbeitsaufgabentyps anhand des Namens ab.

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

Parameter

Gibt zurück

NUR INTERN: Es wird für Farb- und Symbolanbieter verwendet. Holen Sie sich die Wit-Type-Farbe für mehrere Projekte

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

Parameter

Gibt zurück

NUR INTERN: Es wird für die Berufserfahrung in Mein Konto verwendet. Holen Sie sich die Wit-Type-Farbe für mehrere Projekte

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

Parameter

Gibt zurück

Rufen Sie eine Liste von Feldern für einen Arbeitsaufgabentyp mit detaillierten Verweisen ab.

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

Parameter

Gibt zurück

Rufen Sie ein Feld für einen Arbeitsaufgabentyp mit detaillierten Verweisen ab.

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

Parameter

Gibt zurück

Gibt die Liste der Arbeitsaufgabentypen zurück

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

Parameter

Gibt zurück

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

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

Parameter

Gibt zurück

Ruft die Ergebnisse der Abfrage mit 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 mit ihrem WIQL ab.

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

Parameter

Gibt zurück

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

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

Parameter

Gibt zurück

Abrufen eines Batches von Arbeitselementrevisionen mit der Option, gelöschte Elemente einzuschließen

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

Rufen Sie einen Batch von Arbeitsaufgabenrevisionen ab. Diese Anforderung kann verwendet werden, wenn die Liste der Felder groß genug ist, um die URL über die Längenbeschränkung hinaus auszuführen.

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

Parameter

Gibt zurück

Vorlageninhalte ersetzen

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

Parameter

Gibt zurück

Stellt die gelöschte Arbeitsaufgabe 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. Auf diese Weise 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

Aktualisiert eine einzelne Arbeitsaufgabe.

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 Arbeitsaufgabentyps

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

Parameter

Gibt zurück