WorkItemTrackingRestClient class

Referens

Paket:: azure-devops-extension-api

Basklass som ska användas (härleds från) för att göra begäranden till VSS REST API:er

Extends: RestClientBase

Konstruktorer

WorkItemTrackingRestClient(IVssRestClientOptions)

Egenskaper

RESOURCE_AREA_ID

Metoder

createAttachment(any, string, string, string, string)	Laddar upp en bifogad fil.
createField(WorkItemField, string)	Skapa ett nytt fält.
createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Skapa en ny eller uppdatera en befintlig klassificeringsnod.
createQuery(QueryHierarchyItem, string, string, boolean)	Skapar en fråga eller flyttar en fråga.
createTemplate(WorkItemTemplate, string, string)	Skapar en mall
createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)	Skapar ett enda arbetsobjekt.
deleteClassificationNode(string, TreeStructureGroup, string, number)	Ta bort en befintlig klassificeringsnod.
deleteField(string, string)	Tar bort fältet. Information om hur du tar bort en arkiverad fil finns i API:et "Uppdatera fält".
deleteQuery(string, string)	Ta bort en fråga eller en mapp. Detta tar bort alla behörighetsändringar för den borttagna frågan eller mappen och någon av dess underordnade om det är en mapp. Observera att de borttagna behörighetsändringarna inte kan återställas när frågan eller mappen tas bort.
deleteTemplate(string, string, string)	Tar bort mallen med angivet ID
deleteWorkItem(number, string, boolean)	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 kan du också förstöra arbetsobjektet permanent. VARNING! Om parametern destroy är inställd på true går arbetsobjekt som tas bort av det här kommandot INTE till papperskorgen och det finns inget sätt att återställa dem efter borttagningen. Vi rekommenderar att DU INTE använder den här parametern. Om du gör det använder du den här parametern med extrem försiktighet.
destroyWorkItem(number, string)	Förstör det angivna arbetsobjektet permanent från papperskorgen. Det går inte att ångra den här åtgärden.
exportWorkItemTypeDefinition(string, string, boolean)	Exportera arbetsobjekttyp
getAccountMyWorkData(QueryOption)	ENDAST INTERNT: ANVÄNDS AV KONTOT MIN ARBETSSIDA. Detta returnerar information om att utföra, klar, följa och aktivitetsarbetsobjekt.
getAttachmentContent(string, string, string, boolean)	Laddar ned en bifogad fil.
getAttachmentZip(string, string, string, boolean)	Laddar ned en bifogad fil.
getClassificationNode(string, TreeStructureGroup, string, number)	Hämtar klassificeringsnoden för en viss nodsökväg.
getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)	Hämtar rotklassificeringsnoder eller en 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:er. Annars får du rotklassificeringsnoder för det här projektet.
getComment(number, number, string)	Hämtar en kommentar för ett arbetsobjekt vid den angivna revisionen.
getComments(number, string, number, number, CommentSortOrder)	Hämtar det angivna antalet kommentarer för ett arbetsobjekt från den angivna revisionen.
getDeletedWorkItem(number, string)	Hämtar ett borttaget arbetsobjekt från papperskorgen.
getDeletedWorkItems(number[], string)	Hämtar arbetsobjekten från papperskorgen, vars ID har angetts i parametrarna
getDeletedWorkItemShallowReferences(string)	Hämtar en lista över ID:t och URL:erna för de borttagna arbetsobjekten i papperskorgen.
getField(string, string)	Hämtar information om ett visst fält.
getFields(string, GetFieldsExpand)	Returnerar information för alla fält. Parametern projekt-ID/namn är valfri.
getQueries(string, QueryExpand, number, boolean)	Hämtar rotfrågorna och deras underordnade
getQueriesBatch(QueryBatchGetRequest, string)	Hämtar en lista över frågor efter ID:t (maximalt 1 000)
getQuery(string, string, QueryExpand, number, boolean, boolean)	Hämtar en enskild fråga och dess underordnade
getQueryResultCount(string, string, string, boolean, number)	Hämtar resultatet av frågan med tanke på fråge-ID:t.
getRecentActivityData()	Hämtar senaste aktiviteter för arbetsobjekt
getRecentMentions()	ENDAST INTERNT: ANVÄNDS AV KONTOT MIN ARBETSSIDA.
getRelationType(string)	Hämtar definitionen av relationstyp för arbetsobjekt.
getRelationTypes()	Hämtar relationstyperna för arbetsobjekt.
getReportingLinksByLinkType(string, string[], string[], string, Date)	Hämta en batch med arbetsobjektlänkar
getRevision(number, number, string, WorkItemExpand)	Returnerar ett helt hydratiserat arbetsobjekt för den begärda revisionen
getRevisions(number, string, number, number, WorkItemExpand)	Returnerar listan över fullständigt hydratiserade arbetsobjektrevisioner, sidiga.
getRootNodes(string, number)	Hämtar rotklassificeringsnoder under projektet.
getTemplate(string, string, string)	Hämtar mallen med angivet ID
getTemplates(string, string, string)	Hämtar mall
getUpdate(number, number, string)	Returnerar en enskild uppdatering för ett arbetsobjekt
getUpdates(number, string, number, number)	Returnerar deltan mellan arbetsobjektsrevisioner
getWorkArtifactLinkTypes()	Hämta listan över arbetsobjekt som spårar utgående artefaktlänktyper.
getWorkItem(number, string, string[], Date, WorkItemExpand)	Returnerar ett enskilt arbetsobjekt.
getWorkItemIconJson(string, string, number)	Hämta en arbetsobjektikon med det egna namnet och ikonfärgen.
getWorkItemIcons()	Hämta en lista över alla ikoner för arbetsobjekt.
getWorkItemIconSvg(string, string, number)	Hämta en arbetsobjektikon med det egna namnet och ikonfärgen.
getWorkItemIconXaml(string, string, number)	Hämta en arbetsobjektikon med det egna namnet och ikonfärgen.
getWorkItemNextStatesOnCheckinAction(number[], string)	Returnerar nästa tillstånd för de angivna arbetsobjekt-ID:na.
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)	Returnerar en lista över arbetsobjekt (högst 200)
getWorkItemsBatch(WorkItemBatchGetRequest, string)	Hämtar arbetsobjekt för en lista över arbetsobjekts-ID:t (högst 200)
getWorkItemStateColors(string[])	ENDAST INTERNT: Det kommer att användas för min kontoarbetsupplevelse. Hämta statusfärgen för arbetsobjekttyp för flera projekt
getWorkItemTemplate(string, string, string, Date, WorkItemExpand)	Returnerar ett enskilt arbetsobjekt från en mall.
getWorkItemType(string, string)	Returnerar en definition av typen arbetsobjekt.
getWorkItemTypeCategories(string)	Hämta alla kategorier av arbetsobjektstyper.
getWorkItemTypeCategory(string, string)	Hämta specifik typkategori för arbetsobjekt efter namn.
getWorkItemTypeColorAndIcons(string[])	ENDAST INTERNT: Det används för färg- och ikonprovidrar. Hämta wit-typfärgen för flera projekt
getWorkItemTypeColors(string[])	ENDAST INTERNT: Det kommer att användas för min kontoarbetsupplevelse. Hämta wit-typfärgen för flera projekt
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)	Hämta en lista över fält för en arbetsobjekttyp med detaljerade referenser.
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)	Hämta ett fält för en arbetsobjekttyp med detaljerade referenser.
getWorkItemTypes(string)	Returnerar listan över arbetsobjekttyper
getWorkItemTypeStates(string, string)	Returnerar tillståndsnamn och färger för en typ av arbetsobjekt.
queryById(string, string, string, boolean, number)	Hämtar resultatet av frågan med tanke på fråge-ID:t.
queryByWiql(Wiql, string, string, boolean, number)	Hämtar resultatet av frågan med tanke på dess WIQL.
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)	Frågor om arbetsobjekt som är länkade till en viss lista över artefakt-URI.
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)	Hämta en batch med arbetsobjektsrevisioner med alternativet att inkludera borttagna objekt
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)	Hämta en batch med arbetsobjektrevisioner. Den här begäran kan användas om listan över fält är tillräckligt stor för att den ska kunna köra URL:en över längdgränsen.
replaceTemplate(WorkItemTemplate, string, string, string)	Ersätt mallinnehåll
restoreWorkItem(WorkItemDeleteUpdate, number, string)	Återställer det borttagna arbetsobjektet från papperskorgen.
searchQueries(string, string, number, QueryExpand, boolean)	Söker igenom alla frågor som användaren har åtkomst till i det aktuella projektet
sendMail(SendMailBody, string)	RESTful-metod för att skicka e-post för valda/efterfrågade arbetsobjekt.
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Uppdatera en befintlig klassificeringsnod.
updateField(UpdateWorkItemField, string, string)	Uppdatera ett fält.
updateQuery(QueryHierarchyItem, string, string, boolean)	Uppdatera en fråga eller en mapp. På så sätt kan du uppdatera, byta namn på och flytta frågor och mappar.
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)	Uppdateringar ett enda arbetsobjekt.
updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)	Lägg till/uppdaterar en typ av arbetsobjekt

Konstruktorinformation

WorkItemTrackingRestClient(IVssRestClientOptions)

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

Parametrar

options: IVssRestClientOptions

Egenskapsinformation

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Egenskapsvärde

string

Metodinformation

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

Laddar upp en bifogad fil.

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

Parametrar

content: any

Innehåll som ska laddas upp

project: string

Projekt-ID eller projektnamn

fileName: string

Namnet på filen

uploadType: string

Uppladdningstyp för bifogade filer: Enkel eller segmenterad

areaPath: string

Målprojektområdessökväg

Returer

Promise<AttachmentReference>

createField(WorkItemField, string)

Skapa ett nytt fält.

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

Parametrar

workItemField: WorkItemField

Ny fältdefinition

project: string

Projekt-ID eller projektnamn

Returer

Promise<WorkItemField>

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Skapa en ny eller uppdatera en befintlig klassificeringsnod.

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

Parametrar

postedNode: WorkItemClassificationNode

Nod för att skapa eller uppdatera.

project: string

Projekt-ID eller projektnamn

structureGroup: TreeStructureGroup

Strukturgrupp för klassificeringsnoden, området eller iterationen.

path: string

Sökväg för klassificeringsnoden.

Returer

Promise<WorkItemClassificationNode>

createQuery(QueryHierarchyItem, string, string, boolean)

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

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

Parametrar

postedQuery: QueryHierarchyItem

Frågan som ska skapas.

project: string

Projekt-ID eller projektnamn

query: string

Det överordnade ID:t eller sökvägen där frågan ska skapas.

validateWiqlOnly: boolean

Om du bara vill verifiera DIN WIQL-fråga utan att skapa en, ställer du in den på sant. Standardvärdet är false.

Returer

Promise<QueryHierarchyItem>

createTemplate(WorkItemTemplate, string, string)

Skapar en mall

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

Parametrar

template: WorkItemTemplate

Mallinnehåll

project: string

Projekt-ID eller projektnamn

team: string

Team-ID eller teamnamn

Returer

Promise<WorkItemTemplate>

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

Skapar ett enda arbetsobjekt.

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

Parametrar

document: JsonPatchDocument

JSON Patch-dokumentet som representerar arbetsobjektet

project: string

Projekt-ID eller projektnamn

type: string

Arbetsobjektets typ av arbetsobjekt som ska skapas

validateOnly: boolean

Ange om du bara vill verifiera ändringarna utan att spara arbetsobjektet

bypassRules: boolean

Framtvinga inte reglerna för arbetsobjektstyp i den här uppdateringen

suppressNotifications: boolean

Utlös inga meddelanden om den här ändringen

expand: WorkItemExpand

Expanderingsparametrarna för attribut för arbetsobjekt. Möjliga alternativ är { None, Relations, Fields, Links, All }.

Returer

Promise<WorkItem>

deleteClassificationNode(string, TreeStructureGroup, string, number)

Ta bort en befintlig klassificeringsnod.

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

Parametrar

project: string

Projekt-ID eller projektnamn

structureGroup: TreeStructureGroup

Strukturgrupp för klassificeringsnoden, området eller iterationen.

path: string

Sökväg för klassificeringsnoden.

reclassifyId: number

ID för målklassificeringsnoden för omklassificering.

Returer

Promise<void>

deleteField(string, string)

Tar bort fältet. Information om hur du tar bort en arkiverad fil finns i API:et "Uppdatera fält".

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

Parametrar

fieldNameOrRefName: string

Fältets enkla namn eller referensnamn

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

deleteQuery(string, string)

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

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

Parametrar

project: string

Projekt-ID eller projektnamn

query: string

ID eller sökväg till den fråga eller mapp som ska tas bort.

Returer

Promise<void>

deleteTemplate(string, string, string)

Tar bort mallen med angivet ID

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

Parametrar

project: string

Projekt-ID eller projektnamn

team: string

Team-ID eller teamnamn

templateId: string

Mall-ID

Returer

Promise<void>

deleteWorkItem(number, string, boolean)

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 kan du också förstöra arbetsobjektet permanent. VARNING! Om parametern destroy är inställd på true går arbetsobjekt som tas bort av det här kommandot INTE till papperskorgen och det finns inget sätt att återställa dem efter borttagningen. Vi rekommenderar att DU INTE använder den här parametern. Om du gör det använder du den här parametern med extrem försiktighet.

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

Parametrar

id: number

ID för det arbetsobjekt som ska tas bort

project: string

Projekt-ID eller projektnamn

destroy: boolean

Om den valfria parametern är inställd på true tas arbetsobjektet bort permanent. Observera: förstöringsåtgärden är PERMANENT och kan inte ångras.

Returer

Promise<WorkItemDelete>

destroyWorkItem(number, string)

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

id: number

ID för arbetsobjektet som ska förstöras permanent

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

exportWorkItemTypeDefinition(string, string, boolean)

Exportera arbetsobjekttyp

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

Parametrar

project: string

Projekt-ID eller projektnamn

type: string

exportGlobalLists: boolean

Returer

Promise<WorkItemTypeTemplate>

getAccountMyWorkData(QueryOption)

ENDAST INTERNT: ANVÄNDS AV KONTOT MIN ARBETSSIDA. Detta returnerar information om att utföra, klar, följa och aktivitetsarbetsobjekt.

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

Parametrar

queryOption: QueryOption

Returer

Promise<AccountMyWorkResult>

getAttachmentContent(string, string, string, boolean)

Laddar ned en bifogad fil.

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

Parametrar

id: string

ID för bifogade filer

project: string

Projekt-ID eller projektnamn

fileName: string

Namnet på filen

download: boolean

Om värdet <är c>true</c> ladda alltid ned bifogad fil

Returer

Promise<ArrayBuffer>

getAttachmentZip(string, string, string, boolean)

Laddar ned en bifogad fil.

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

Parametrar

id: string

ID för bifogade filer

project: string

Projekt-ID eller projektnamn

fileName: string

Namnet på filen

download: boolean

Om värdet <är c>true</c> ladda alltid ned bifogad fil

Returer

Promise<ArrayBuffer>

getClassificationNode(string, TreeStructureGroup, string, number)

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

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

Parametrar

project: string

Projekt-ID eller projektnamn

structureGroup: TreeStructureGroup

Strukturgrupp för klassificeringsnoden, området eller iterationen.

path: string

Sökväg för klassificeringsnoden.

depth: number

Djup på underordnade som ska hämtas.

Returer

Promise<WorkItemClassificationNode>

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

Hämtar rotklassificeringsnoder eller en 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:er. Annars får du rotklassificeringsnoder för det här projektet.

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

Parametrar

project: string

Projekt-ID eller projektnamn

ids: number[]

ID:t för kommaavgränsade heltalsklassificeringsnoder. Det krävs inte om du vill ha rotnoder.

depth: number

Djup på underordnade som ska hämtas.

errorPolicy: ClassificationNodesErrorPolicy

Flagga för att hantera fel vid hämtar vissa noder. Möjliga alternativ är Misslyckas och Utelämna.

Returer

Promise<WorkItemClassificationNode[]>

getComment(number, number, string)

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

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

Parametrar

id: number

Arbetsobjekt-ID

revision: number

Revision för vilken kommentaren måste hämtas

project: string

Projekt-ID eller projektnamn

Returer

Promise<WorkItemComment>

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

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

id: number

Arbetsobjekt-ID

project: string

Projekt-ID eller projektnamn

fromRevision: number

Revision från vilken kommentarer ska hämtas (standard är 1)

top: number

Antalet kommentarer som ska returneras (standardvärdet är 200)

order: CommentSortOrder

Stigande eller fallande efter revisions-ID (standard är stigande)

Returer

Promise<WorkItemComments>

getDeletedWorkItem(number, string)

Hämtar ett borttaget arbetsobjekt från papperskorgen.

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

Parametrar

id: number

ID för arbetsobjektet som ska returneras

project: string

Projekt-ID eller projektnamn

Returer

Promise<WorkItemDelete>

getDeletedWorkItems(number[], string)

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

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

Parametrar

ids: number[]

Kommaavgränsad lista över ID:t för de borttagna arbetsobjekt som ska returneras

project: string

Projekt-ID eller projektnamn

Returer

Promise<WorkItemDeleteReference[]>

getDeletedWorkItemShallowReferences(string)

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

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

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<WorkItemDeleteShallowReference[]>

getField(string, string)

Hämtar information om ett visst fält.

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

Parametrar

fieldNameOrRefName: string

Fältets enkla namn eller referensnamn

project: string

Projekt-ID eller projektnamn

Returer

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

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

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

Parametrar

project: string

Projekt-ID eller projektnamn

expand: GetFieldsExpand

Använd ExtensionFields för att inkludera tilläggsfält, annars exkludera dem. Om inte funktionsflaggan för den här parametern är aktiverad inkluderas alltid tilläggsfält.

Returer

Promise<WorkItemField[]>

getQueries(string, QueryExpand, number, boolean)

Hämtar rotfrågorna och deras underordnade

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

Parametrar

project: string

Projekt-ID eller projektnamn

expand: QueryExpand

Inkludera frågesträngen (wiql), satser, frågeresultatkolumner och sorteringsalternativ i resultatet.

depth: number

I mappen med frågor returnerar du underordnade frågor och mappar till det här djupet.

includeDeleted: boolean

Inkludera borttagna frågor och mappar

Returer

Promise<QueryHierarchyItem[]>

getQueriesBatch(QueryBatchGetRequest, string)

Hämtar en lista över frågor efter ID:t (maximalt 1 000)

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

Parametrar

queryGetRequest: QueryBatchGetRequest

project: string

Projekt-ID eller projektnamn

Returer

Promise<QueryHierarchyItem[]>

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

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

project: string

Projekt-ID eller projektnamn

query: string

ID eller sökväg till frågan.

expand: QueryExpand

Inkludera frågesträngen (wiql), satser, frågeresultatkolumner och sorteringsalternativ i resultatet.

depth: number

I mappen med frågor returnerar du underordnade frågor och mappar till det här djupet.

includeDeleted: boolean

Inkludera borttagna frågor och mappar

useIsoDateFormat: boolean

DateTime-frågesatser formateras med ett ISO 8601-kompatibelt format

Returer

Promise<QueryHierarchyItem>

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

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

id: string

Fråge-ID:t.

project: string

Projekt-ID eller projektnamn

team: string

Team-ID eller teamnamn

timePrecision: boolean

Om du vill använda tidsprecision eller inte.

top: number

Det maximala antalet resultat som ska returneras.

Returer

Promise<number>

getRecentActivityData()

Hämtar senaste aktiviteter för arbetsobjekt

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Returer

Promise<AccountRecentActivityWorkItemModel2[]>

getRecentMentions()

ENDAST INTERNT: ANVÄNDS AV KONTOT MIN ARBETSSIDA.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Returer

Promise<AccountRecentMentionWorkItemModel[]>

getRelationType(string)

Hämtar definitionen av relationstyp för arbetsobjekt.

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

Parametrar

relation: string

Relationsnamnet

Returer

Promise<WorkItemRelationType>

getRelationTypes()

Hämtar relationstyperna för arbetsobjekt.

function getRelationTypes(): Promise<WorkItemRelationType[]>

Returer

Promise<WorkItemRelationType[]>

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

Hämta en batch med arbetsobjektlänkar

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

Parametrar

project: string

Projekt-ID eller projektnamn

linkTypes: string[]

En lista med typer för att filtrera resultatet till specifika länktyper. Utelämna den här parametern för att hämta länkar till arbetsobjekt för alla länktyper.

types: string[]

En lista över typer för att filtrera resultatet till specifika typer av arbetsobjekt. Utelämna den här parametern för att hämta länkar till arbetsobjekt för alla typer av arbetsobjekt.

continuationToken: string

Anger fortsättningenToken som batchen ska startas från. Utelämna den här parametern för att hämta den första batchen med länkar.

startDateTime: Date

Datum/tid som ska användas som startpunkt för länkändringar. Endast länkändringar som har inträffat efter det datumet/tiden returneras. Det går inte att använda tillsammans med parametern "vattenstämpel".

Returer

Promise<ReportingWorkItemLinksBatch>

getRevision(number, number, string, WorkItemExpand)

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

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

Parametrar

id: number

revisionNumber: number

project: string

Projekt-ID eller projektnamn

expand: WorkItemExpand

Returer

Promise<WorkItem>

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

Returnerar listan över fullständigt hydratiserade arbetsobjektrevisioner, sidiga.

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

Parametrar

id: number

project: string

Projekt-ID eller projektnamn

top: number

skip: number

expand: WorkItemExpand

Returer

Promise<WorkItem[]>

getRootNodes(string, number)

Hämtar rotklassificeringsnoder under projektet.

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

Parametrar

project: string

Projekt-ID eller projektnamn

depth: number

Djup på underordnade som ska hämtas.

Returer

Promise<WorkItemClassificationNode[]>

getTemplate(string, string, string)

Hämtar mallen med angivet ID

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

Parametrar

project: string

Projekt-ID eller projektnamn

team: string

Team-ID eller teamnamn

templateId: string

Mall-ID

Returer

Promise<WorkItemTemplate>

getTemplates(string, string, string)

Hämtar mall

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

Parametrar

project: string

Projekt-ID eller projektnamn

team: string

Team-ID eller teamnamn

workitemtypename: string

Valfritt, När det anges returnerar mallar för angiven typ av arbetsobjekt.

Returer

Promise<WorkItemTemplateReference[]>

getUpdate(number, number, string)

Returnerar en enskild uppdatering för ett arbetsobjekt

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

Parametrar

id: number

updateNumber: number

project: string

Projekt-ID eller projektnamn

Returer

Promise<WorkItemUpdate>

getUpdates(number, string, number, number)

Returnerar deltan mellan arbetsobjektsrevisioner

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

Parametrar

id: number

project: string

Projekt-ID eller projektnamn

top: number

skip: number

Returer

Promise<WorkItemUpdate[]>

getWorkArtifactLinkTypes()

Hämta listan över arbetsobjekt som spårar utgående artefaktlänktyper.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

Returer

Promise<WorkArtifactLink[]>

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

Returnerar ett enskilt arbetsobjekt.

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

Parametrar

id: number

Arbetsobjektets ID

project: string

Projekt-ID eller projektnamn

fields: string[]

Kommaavgränsad lista över begärda fält

asOf: Date

AsOf UTC-datumtidssträng

expand: WorkItemExpand

Expanderingsparametrarna för attribut för arbetsobjekt. Möjliga alternativ är { None, Relations, Fields, Links, All }.

Returer

Promise<WorkItem>

getWorkItemIconJson(string, string, number)

Hämta en arbetsobjektikon med det egna namnet och ikonfärgen.

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

Parametrar

icon: string

Namnet på ikonen

color: string

Den sexsiffriga hexfärgen för ikonen

v: number

Ikonens version (används endast för cache-ogiltighet)

Returer

Promise<WorkItemIcon>

getWorkItemIcons()

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

function getWorkItemIcons(): Promise<WorkItemIcon[]>

Returer

Promise<WorkItemIcon[]>

getWorkItemIconSvg(string, string, number)

Hämta en arbetsobjektikon med det egna namnet och ikonfärgen.

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

Parametrar

icon: string

Namnet på ikonen

color: string

Den sexsiffriga hexfärgen för ikonen

v: number

Ikonens version (används endast för cache-ogiltighet)

Returer

Promise<any>

getWorkItemIconXaml(string, string, number)

Hämta en arbetsobjektikon med det egna namnet och ikonfärgen.

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

Parametrar

icon: string

Namnet på ikonen

color: string

Den sexsiffriga hexfärgen för ikonen

v: number

Ikonens version (används endast för cache-ogiltighet)

Returer

Promise<any>

getWorkItemNextStatesOnCheckinAction(number[], string)

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

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

Parametrar

ids: number[]

lista över arbetsobjekts-ID:t

action: string

möjliga åtgärder. För närvarande har endast stöd för incheckning

Returer

Promise<WorkItemNextStateOnTransition[]>

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

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

ids: number[]

Kommaavgränsad lista över begärda arbetsobjekts-ID:t. (Högst 200 ID:t tillåts).

project: string

Projekt-ID eller projektnamn

fields: string[]

Kommaavgränsad lista över begärda fält

asOf: Date

AsOf UTC-datumtidssträng

expand: WorkItemExpand

Expanderingsparametrarna för attribut för arbetsobjekt. Möjliga alternativ är { None, Relations, Fields, Links, All }.

errorPolicy: WorkItemErrorPolicy

Flaggan för att styra felprincipen i en massbegäran om att hämta arbetsobjekt. Möjliga alternativ är {Fail, Omit}.

Returer

Promise<WorkItem[]>

getWorkItemsBatch(WorkItemBatchGetRequest, string)

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

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

Parametrar

workItemGetRequest: WorkItemBatchGetRequest

project: string

Projekt-ID eller projektnamn

Returer

Promise<WorkItem[]>

getWorkItemStateColors(string[])

ENDAST INTERNT: Det kommer att användas för min kontoarbetsupplevelse. Hämta statusfärgen för arbetsobjekttyp för flera projekt

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

Parametrar

projectNames: string[]

Returer

Promise<ProjectWorkItemStateColors[]>

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

Returnerar ett enskilt arbetsobjekt från en mall.

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

Parametrar

project: string

Projekt-ID eller projektnamn

type: string

Namnet på arbetsobjektets typ

fields: string

Kommaavgränsad lista över begärda fält

asOf: Date

AsOf UTC-datumtidssträng

expand: WorkItemExpand

Expanderingsparametrarna för attribut för arbetsobjekt. Möjliga alternativ är { None, Relations, Fields, Links, All }.

Returer

Promise<WorkItem>

getWorkItemType(string, string)

Returnerar en definition av typen arbetsobjekt.

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

Parametrar

project: string

Projekt-ID eller projektnamn

type: string

Namn på arbetsobjekttyp

Returer

Promise<WorkItemType>

getWorkItemTypeCategories(string)

Hämta alla kategorier av arbetsobjektstyper.

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

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<WorkItemTypeCategory[]>

getWorkItemTypeCategory(string, string)

Hämta specifik typkategori för arbetsobjekt efter namn.

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

Parametrar

project: string

Projekt-ID eller projektnamn

category: string

Kategorinamnet

Returer

Promise<WorkItemTypeCategory>

getWorkItemTypeColorAndIcons(string[])

ENDAST INTERNT: Det används för färg- och ikonprovidrar. Hämta wit-typfärgen för flera projekt

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

Parametrar

projectNames: string[]

Returer

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

getWorkItemTypeColors(string[])

ENDAST INTERNT: Det kommer att användas för min kontoarbetsupplevelse. Hämta wit-typfärgen för flera projekt

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

Parametrar

projectNames: string[]

Returer

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

getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)

Hämta en lista över fält för en arbetsobjekttyp med detaljerade referenser.

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

Parametrar

project: string

Projekt-ID eller projektnamn

type: string

Typ av arbetsobjekt.

expand: WorkItemTypeFieldsExpandLevel

Expandera nivån för API-svaret. Egenskaper: att inkludera allowedvalues, standardvärde, isRequired osv. som en del av svaret; Ingen: för att hoppa över dessa egenskaper.

Returer

Promise<WorkItemTypeFieldWithReferences[]>

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

Hämta ett fält för en arbetsobjekttyp med detaljerade referenser.

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

Parametrar

project: string

Projekt-ID eller projektnamn

type: string

Typ av arbetsobjekt.

field: string

expand: WorkItemTypeFieldsExpandLevel

Expandera nivån för API-svaret. Egenskaper: att inkludera allowedvalues, standardvärde, isRequired osv. som en del av svaret; Ingen: för att hoppa över dessa egenskaper.

Returer

Promise<WorkItemTypeFieldWithReferences>

getWorkItemTypes(string)

Returnerar listan över arbetsobjekttyper

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

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<WorkItemType[]>

getWorkItemTypeStates(string, string)

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

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

Parametrar

project: string

Projekt-ID eller projektnamn

type: string

Tillståndsnamnet

Returer

Promise<WorkItemStateColor[]>

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

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

id: string

Fråge-ID:t.

project: string

Projekt-ID eller projektnamn

team: string

Team-ID eller teamnamn

timePrecision: boolean

Om du vill använda tidsprecision eller inte.

top: number

Det maximala antalet resultat som ska returneras.

Returer

Promise<WorkItemQueryResult>

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

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

wiql: Wiql

Frågan som innehåller WIQL.

project: string

Projekt-ID eller projektnamn

team: string

Team-ID eller teamnamn

timePrecision: boolean

Om du vill använda tidsprecision eller inte.

top: number

Det maximala antalet resultat som ska returneras.

Returer

Promise<WorkItemQueryResult>

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

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

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

Parametrar

artifactUriQuery: ArtifactUriQuery

Definierar en lista över artefakt-URI för frågor mot arbetsobjekt.

project: string

Projekt-ID eller projektnamn

Returer

Promise<ArtifactUriQueryResult>

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

Hämta en batch med arbetsobjektsrevisioner 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

project: string

Projekt-ID eller projektnamn

fields: string[]

En lista över fält som ska returneras i arbetsobjektsrevisioner. Utelämna den här parametern för att hämta alla rapportbara fält.

types: string[]

En lista över typer för att filtrera resultatet till specifika typer av arbetsobjekt. Utelämna den här parametern för att hämta arbetsobjektsrevisioner av alla typer av arbetsobjekt.

continuationToken: string

Anger vattenstämpeln som batchen ska startas från. Utelämna den här parametern för att hämta den första batchen med revisioner.

startDateTime: Date

Datum/tid som ska användas som startpunkt för revisioner sker alla revisioner efter detta datum/tid. Det går inte att använda tillsammans med parametern "vattenstämpel".

includeIdentityRef: boolean

Returnera en identitetsreferens i stället för ett strängvärde för identitetsfält.

includeDeleted: boolean

Ange om det borttagna objektet ska returneras.

includeTagRef: boolean

Ange om taggobjekten ska returneras för fältet System.Tags.

includeLatestOnly: boolean

Returnera endast de senaste revisionerna av arbetsobjekt och hoppa över alla historiska revisioner

expand: ReportingRevisionsExpand

Returnera alla fält i arbetsobjektsrevisioner, inklusive långa textfält som inte returneras som standard

includeDiscussionChangesOnly: boolean

Returnera endast de revisioner av arbetsobjekt där endast historikfältet har ändrats

maxPageSize: number

Det maximala antalet resultat som ska returneras i den här batchen

Returer

Promise<ReportingWorkItemRevisionsBatch>

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

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

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

Parametrar

filter: ReportingWorkItemRevisionsFilter

Ett objekt som innehåller begärandeinställningar: fältfilter, typfilter, identitetsformat

project: string

Projekt-ID eller projektnamn

continuationToken: string

Anger vattenstämpeln som batchen ska startas från. Utelämna den här parametern för att hämta den första batchen med revisioner.

startDateTime: Date

Datum/tid som ska användas som startpunkt för revisioner sker alla revisioner efter detta datum/tid. Det går inte att använda tillsammans med parametern "vattenstämpel".

expand: ReportingRevisionsExpand

Returer

Promise<ReportingWorkItemRevisionsBatch>

replaceTemplate(WorkItemTemplate, string, string, string)

Ersätt mallinnehåll

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

Parametrar

templateContent: WorkItemTemplate

Mallinnehåll som ska ersättas med

project: string

Projekt-ID eller projektnamn

team: string

Team-ID eller teamnamn

templateId: string

Mall-ID

Returer

Promise<WorkItemTemplate>

restoreWorkItem(WorkItemDeleteUpdate, number, string)

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

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

Parametrar

payload: WorkItemDeleteUpdate

Betala med instruktioner för att uppdatera IsDeleted-flaggan till false

id: number

ID för arbetsobjektet som ska återställas

project: string

Projekt-ID eller projektnamn

Returer

Promise<WorkItemDelete>

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

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

project: string

Projekt-ID eller projektnamn

filter: string

Texten som frågorna ska filtreras med.

top: number

Antalet frågor som ska returneras (standardvärdet är 50 och max är 200).

expand: QueryExpand

includeDeleted: boolean

Inkludera borttagna frågor och mappar

Returer

Promise<QueryHierarchyItemsResult>

sendMail(SendMailBody, string)

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

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

Parametrar

body: SendMailBody

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Uppdatera en befintlig klassificeringsnod.

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

Parametrar

postedNode: WorkItemClassificationNode

Nod för att skapa eller uppdatera.

project: string

Projekt-ID eller projektnamn

structureGroup: TreeStructureGroup

Strukturgrupp för klassificeringsnoden, området eller iterationen.

path: string

Sökväg för klassificeringsnoden.

Returer

Promise<WorkItemClassificationNode>

updateField(UpdateWorkItemField, string, string)

Uppdatera ett fält.

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

Parametrar

payload: UpdateWorkItemField

Nyttolasten innehåller önskat värde för fältets egenskaper

fieldNameOrRefName: string

Namn/referensnamn för fältet som ska uppdateras

project: string

Projekt-ID eller projektnamn

Returer

Promise<WorkItemField>

updateQuery(QueryHierarchyItem, string, string, boolean)

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

queryUpdate: QueryHierarchyItem

Frågan som ska uppdateras.

project: string

Projekt-ID eller projektnamn

query: string

ID:t eller sökvägen för frågan som ska uppdateras.

undeleteDescendants: boolean

Ta bort underordnade objekt i den här mappen. Det är viktigt att notera att detta inte kommer att återställa de behörighetsändringar som tidigare tillämpades på underordnade.

Returer

Promise<QueryHierarchyItem>

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

Uppdateringar ett enda arbetsobjekt.

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

Parametrar

document: JsonPatchDocument

JSON-korrigeringsdokumentet som representerar uppdateringen

id: number

ID:t för arbetsobjektet som ska uppdateras

project: string

Projekt-ID eller projektnamn

validateOnly: boolean

Ange om du bara vill verifiera ändringarna utan att spara arbetsobjektet

bypassRules: boolean

Framtvinga inte arbetsobjektets typregler för den här uppdateringen

suppressNotifications: boolean

Utlös inga meddelanden för den här ändringen

expand: WorkItemExpand

Expanderingsparametrarna för arbetsobjektattribut. Möjliga alternativ är { None, Relations, Fields, Links, All }.

Returer

Promise<WorkItem>

updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)

Lägg till/uppdaterar en typ av arbetsobjekt

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

Parametrar

updateModel: WorkItemTypeTemplateUpdateModel

project: string

Projekt-ID eller projektnamn

Returer

Promise<ProvisioningResult>

Dela via

WorkItemTrackingRestClient class

Konstruktorer

Egenskaper

Metoder

Konstruktorinformation

WorkItemTrackingRestClient(IVssRestClientOptions)

Parametrar

Egenskapsinformation

RESOURCE_AREA_ID

Egenskapsvärde

Metodinformation

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

Parametrar

Returer

createField(WorkItemField, string)

Parametrar

Returer

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Parametrar

Returer

createQuery(QueryHierarchyItem, string, string, boolean)

Parametrar

Returer

createTemplate(WorkItemTemplate, string, string)

Parametrar

Returer

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

Parametrar

Returer

deleteClassificationNode(string, TreeStructureGroup, string, number)

Parametrar

Returer

deleteField(string, string)

Parametrar

Returer

deleteQuery(string, string)

Parametrar

Returer

deleteTemplate(string, string, string)

Parametrar

Returer

deleteWorkItem(number, string, boolean)

Parametrar

Returer

destroyWorkItem(number, string)

Parametrar

Returer

exportWorkItemTypeDefinition(string, string, boolean)

Parametrar

Returer

getAccountMyWorkData(QueryOption)

Parametrar

Returer

getAttachmentContent(string, string, string, boolean)

Parametrar

Returer

getAttachmentZip(string, string, string, boolean)

Parametrar

Returer

getClassificationNode(string, TreeStructureGroup, string, number)

Parametrar

Returer

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

Parametrar

Returer

getComment(number, number, string)

Parametrar

Returer

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

Parametrar

Returer

getDeletedWorkItem(number, string)

Parametrar

Returer

getDeletedWorkItems(number[], string)

Parametrar

Returer

getDeletedWorkItemShallowReferences(string)

Parametrar