WorkItemTrackingRestClient class

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

Parametrar

static RESOURCE_AREA_ID: string

Egenskapsvärde

Laddar upp en bilaga.

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

Parametrar

Returer

Skapa ett nytt fält.

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

Parametrar

Returer

Skapa en ny eller uppdatera en befintlig klassificeringsnod.

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

Parametrar

Returer

Skapar en fråga eller flyttar en fråga.

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

Parametrar

Returer

Skapar en mall

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

Parametrar

Returer

Skapar ett enda arbetsobjekt.

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

Parametrar

Returer

Ta bort en befintlig klassificeringsnod.

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

Parametrar

Returer

Tar bort fältet. Information om hur du ångrar en fil finns i API:t "Update Field".

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

Parametrar

Returer

Ta bort en fråga eller en mapp. Detta tar bort alla behörighetsändringar för den borttagna frågan eller mappen och alla dess underordnade om det är en mapp. Det är viktigt att notera att de borttagna behörighetsändringarna inte kan återställas när du tar bort frågan eller mappen.

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

Parametrar

Returer

Tar bort mallen med angivet id

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

Parametrar

Returer

Tar bort det angivna arbetsobjektet och skickar det till papperskorgen så att det kan återställas om det behövs. Om parametern destroy har angetts till true förstörs arbetsobjektet permanent. VARNING: Om parametern destroy är inställd på true kommer arbetsobjekt som tas bort med det här kommandot INTE att hamna i papperskorgen och det finns inget sätt att återställa/återställa dem efter borttagningen. Vi rekommenderar att du INTE använder den här parametern. Om du gör det, använd den här parametern med extrem försiktighet.

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

Parametrar

Returer

Förstör det angivna arbetsobjektet permanent från papperskorgen. Det går inte att ångra den här åtgärden.

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

Parametrar

Returer

Exportera typ av arbetsobjekt

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

Parametrar

Returer

ENDAST INTERNT: ANVÄNDS AV SIDAN KONTO MITT ARBETE. Detta returnerar information om Påförande, Klar, Följer och aktivitetsarbetsobjekt.

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

Parametrar

Returer

Hämtar en bifogad fil.

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

Parametrar

Returer

Hämtar en bifogad fil.

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

Parametrar

Returer

Hämtar klassificeringsnoden för en viss nodsökväg.

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

Parametrar

Returer

Hämtar rotklassificeringsnoder eller lista över klassificeringsnoder för en viss lista över nod-ID:t för ett visst projekt. Om parametern ids anges får du en lista över klassificeringsnoder för dessa id:n. Annars får du rotklassificeringsnoder för det här projektet.

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

Parametrar

Returer

Hämtar en kommentar för ett arbetsobjekt vid den angivna revisionen.

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

Parametrar

Returer

Hämtar det angivna antalet kommentarer för ett arbetsobjekt från den angivna revisionen.

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

Parametrar

Returer

Hämtar ett borttaget arbetsobjekt från papperskorgen.

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

Parametrar

Returer

Hämtar arbetsobjekten från papperskorgen, vars ID:t har angetts i parametrarna

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

Parametrar

Returer

Hämtar en lista över ID:t och URL:erna för de borttagna arbetsobjekten i papperskorgen.

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

Parametrar

Returer

Hämtar information om ett specifikt fält.

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

Parametrar

Returer

Returnerar information för alla fält. Parametern projekt-ID/namn är valfri.

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

Parametrar

Returer

Hämtar rotfrågorna och deras underordnade

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

Parametrar

Returer

Hämtar en lista över frågor efter ID:n (högst 1000)

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

Parametrar

Returer

Hämtar en enskild fråga och dess underordnade

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

Parametrar

Returer

Hämtar resultatet av frågan med tanke på fråge-ID:t.

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

Parametrar

Returer

Hämtar de senaste aktiviteterna för arbetsobjekt

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Returer

ENDAST INTERNT: ANVÄNDS AV SIDAN KONTO MITT ARBETE.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Returer

Hämtar definitionen av relationstyp för arbetsobjektet.

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

Parametrar

Returer

Hämtar relationstyperna för arbetsobjekt.

function getRelationTypes(): Promise<WorkItemRelationType[]>

Returer

Hämta en batch med länkar till arbetsobjekt

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

Parametrar

Returer

Returnerar ett helt hydratiserat arbetsobjekt för den begärda revisionen

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

Parametrar

Returer

Returnerar listan över fullständigt hydratiserade revisioner av arbetsobjekt, sidindelade.

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

Parametrar

Returer

Hämtar rotklassificeringsnoder under projektet.

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

Parametrar

Returer

Hämtar mallen med angivet id

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

Parametrar

Returer

Hämtar mall

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

Parametrar

Returer

Returnerar en enskild uppdatering för ett arbetsobjekt

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

Parametrar

Returer

Returnerar deltan mellan revisioner av arbetsobjekt

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

Parametrar

Returer

Hämta listan över länktyper för utgående artefakter för spårning av arbetsobjekt.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

Returer

Returnerar ett enskilt arbetsobjekt.

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

Parametrar

Returer

Hämta en ikon för arbetsobjekt med det egna namnet och ikonfärgen.

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

Parametrar

Returer

Hämta en lista över alla ikoner för arbetsobjekt.

function getWorkItemIcons(): Promise<WorkItemIcon[]>

Returer

Hämta en ikon för arbetsobjekt med det egna namnet och ikonfärgen.

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

Parametrar

Returer

Hämta en ikon för arbetsobjekt med det egna namnet och ikonfärgen.

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

Parametrar

Returer

Returnerar nästa tillstånd för de angivna arbetsobjekts-ID:t.

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

Parametrar

Returer

Returnerar en lista över arbetsobjekt (högst 200)

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

Parametrar

Returer

Hämtar arbetsobjekt för en lista över arbetsobjekts-ID:t (högst 200)

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

Parametrar

Returer

ENDAST INTERNT: Den kommer att användas för arbetslivserfarenhet för Mitt konto. Hämta tillståndsfärgen för arbetsobjektstyp för flera projekt

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

Parametrar

Returer

Returnerar ett enskilt arbetsobjekt från en mall.

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

Parametrar

Returer

Returnerar en definition av typ av arbetsobjekt.

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

Parametrar

Returer

Hämta alla kategorier av arbetsobjektstyper.

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

Parametrar

Returer

Hämta en specifik kategori av arbetsobjekttyp efter namn.

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

Parametrar

Returer

ENDAST INTERNT: Den används för färg- och ikonleverantörer. Få wit-typfärgen för flera projekt

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

Parametrar

Returer

ENDAST INTERNT: Den kommer att användas för arbetslivserfarenhet för Mitt konto. Få wit-typfärgen för flera projekt

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

Parametrar

Returer

Hämta en lista över fält för en typ av arbetsobjekt med detaljerade referenser.

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

Parametrar

Returer

Hämta ett fält för en typ av arbetsobjekt med detaljerade referenser.

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

Parametrar

Returer

Returnerar listan över typer av arbetsobjekt

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

Parametrar

Returer

Returnerar tillståndsnamn och färger för en typ av arbetsobjekt.

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

Parametrar

Returer

Hämtar resultatet av frågan med tanke på fråge-ID:t.

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

Parametrar

Returer

Hämtar resultatet av frågan med tanke på dess WIQL.

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

Parametrar

Returer

Frågar efter arbetsobjekt som är länkade till en viss lista över artefakt-URI.

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

Parametrar

Returer

Hämta en batch med revisioner av arbetsobjekt med alternativet att inkludera borttagna objekt

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>

Parametrar

Returer

Hämta en batch med revisioner av arbetsobjekt. Den här begäran kan användas om listan med fält är tillräckligt stor för att URL:en ska kunna köras över längdgränsen.

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

Parametrar

Returer

Ersätt mallinnehåll

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

Parametrar

Returer

Återställer det borttagna arbetsobjektet från papperskorgen.

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

Parametrar

Returer

Söker igenom alla frågor som användaren har åtkomst till i det aktuella projektet

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

Parametrar

Returer

RESTful-metod för att skicka e-post för valda/efterfrågade arbetsobjekt.

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

Parametrar

Returer

Uppdatera en befintlig klassificeringsnod.

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

Parametrar

Returer

Uppdatera ett fält.

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

Parametrar

Returer

Uppdatera en fråga eller en mapp. På så sätt kan du uppdatera, byta namn på och flytta frågor och mappar.

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

Parametrar

Returer

Uppdaterar ett enskilt arbetsobjekt.

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

Parametrar

Returer

Lägga till/uppdatera en typ av arbetsobjekt

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

Parametrar

Returer