WorkItemTrackingRestClient class

Balíček:: azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST API služby VSS

Extends: RestClientBase

Konstruktory

WorkItemTrackingRestClient(IVssRestClientOptions)

Vlastnosti

Metody

createAttachment(any, string, string, string, string)	Nahraje přílohu.
createField(WorkItemField, string)	Vytvořte nové pole.
createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Vytvořte nový nebo aktualizujte existující uzel klasifikace.
createQuery(QueryHierarchyItem, string, string, boolean)	Vytvoří dotaz nebo přesune dotaz.
createTemplate(WorkItemTemplate, string, string)	Vytvoří šablonu
createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)	Vytvoří jednu pracovní položku.
deleteClassificationNode(string, TreeStructureGroup, string, number)	Odstraňte existující uzel klasifikace.
deleteField(string, string)	Odstraní pole. Chcete-li obnovit smazaný soubor, přečtěte si článek Rozhraní API "Aktualizovat pole".
deleteQuery(string, string)	Odstraňte dotaz nebo složku. Tím se odstraní všechny změny oprávnění u odstraněného dotazu nebo složky a všech jejích potomků, pokud se jedná o složku. Je důležité si uvědomit, že odstraněné změny oprávnění nelze po obnovení dotazu nebo složky obnovit.
deleteTemplate(string, string, string)	Smaže šablonu se zadaným id
deleteWorkItem(number, string, boolean)	Odstraní zadanou pracovní položku a odešle ji do koše, aby ji bylo možné v případě potřeby obnovit zpět. Volitelně, pokud byl parametr destroy nastaven na hodnotu true, zničí pracovní položku trvale. UPOZORNĚNÍ: Pokud je parametr destroy nastaven na hodnotu true, pracovní položky odstraněné tímto příkazem NEPŘEJDOU do koše a neexistuje způsob, jak je po odstranění obnovit nebo obnovit. Tento parametr se nedoporučuje používat. Pokud tak učiníte, používejte tento parametr s maximální opatrností.
destroyWorkItem(number, string)	Trvale zničí zadanou pracovní položku z koše. Tuto akci nelze vrátit zpět.
exportWorkItemTypeDefinition(string, string, boolean)	Export typu pracovní položky
getAccountMyWorkData(QueryOption)	POUZE INTERNÍ: POUŽÍVÁ SE ÚČET MOJE PRACOVNÍ STRÁNKA. Tím se vrátí podrobnosti o pracovních položkách Dělám, Hotovo, Sleduje a aktivita.
getAttachmentContent(string, string, string, boolean)	Stáhne přílohu.
getAttachmentZip(string, string, string, boolean)	Stáhne přílohu.
getClassificationNode(string, TreeStructureGroup, string, number)	Získá klasifikační uzel pro danou cestu uzlu.
getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)	Získá kořenové klasifikační uzly nebo seznam klasifikačních uzlů pro daný seznam ID uzlů pro daný projekt. V případě, že je zadán parametr ids, získáte seznam klasifikačních uzlů pro tato id. V opačném případě získáte kořenové klasifikační uzly pro tento projekt.
getComment(number, number, string)	Získá komentář k pracovní položce v zadané revizi.
getComments(number, string, number, number, CommentSortOrder)	Získá zadaný počet komentářů pro pracovní položku ze zadané revize.
getDeletedWorkItem(number, string)	Získá odstraněnou pracovní položku z koše.
getDeletedWorkItems(number[], string)	Získá pracovní položky z koše, jejichž ID byla zadána v parametrech
getDeletedWorkItemShallowReferences(string)	Získá seznam ID a adres URL odstraněných pracovních položek v koši.
getField(string, string)	Získá informace o určitém poli.
getFields(string, GetFieldsExpand)	Vrací informace pro všechna pole. Parametr ID/name projektu je volitelný.
getQueries(string, QueryExpand, number, boolean)	Získá kořenové dotazy a jejich podřízené dotazy
getQueriesBatch(QueryBatchGetRequest, string)	Získá seznam dotazů podle id (maximálně 1000)
getQuery(string, string, QueryExpand, number, boolean, boolean)	Načte jednotlivý dotaz a jeho podřízené položky
getQueryResultCount(string, string, string, boolean, number)	Získá výsledky dotazu s daným ID dotazu.
getRecentActivityData()	Získá nedávné aktivity pracovních položek
getRecentMentions()	POUZE INTERNÍ: POUŽÍVÁ SE ÚČET MOJE PRACOVNÍ STRÁNKA.
getRelationType(string)	Získá definici typu vztahu pracovní položky.
getRelationTypes()	Získá typy vztahů pracovních položek.
getReportingLinksByLinkType(string, string[], string[], string, Date)	Získání dávky odkazů na pracovní položky
getRevision(number, number, string, WorkItemExpand)	Vrátí plně hydratovanou pracovní položku pro požadovanou revizi
getRevisions(number, string, number, number, WorkItemExpand)	Vrátí seznam plně hydratovaných revizí pracovních položek, stránkovaných.
getRootNodes(string, number)	Získá kořenové klasifikační uzly v rámci projektu.
getTemplate(string, string, string)	Získá šablonu se zadaným id
getTemplates(string, string, string)	Získá šablonu
getUpdate(number, number, string)	Vrátí jednu aktualizaci pracovní položky
getUpdates(number, string, number, number)	Vrátí rozdíly mezi revizemi pracovních položek
getWorkArtifactLinkTypes()	Získejte seznam typů odkazů na odchozí artefakty sledujících pracovní položky.
getWorkItem(number, string, string[], Date, WorkItemExpand)	Vrátí jednu pracovní položku.
getWorkItemIconJson(string, string, number)	Získejte ikonu pracovní položky s popisným názvem a barvou ikony.
getWorkItemIcons()	Získejte seznam všech ikon pracovních položek.
getWorkItemIconSvg(string, string, number)	Získejte ikonu pracovní položky s popisným názvem a barvou ikony.
getWorkItemIconXaml(string, string, number)	Získejte ikonu pracovní položky s popisným názvem a barvou ikony.
getWorkItemNextStatesOnCheckinAction(number[], string)	Vrátí další stav na daných ID pracovních položek.
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)	Vrátí seznam pracovních položek (maximálně 200).
getWorkItemsBatch(WorkItemBatchGetRequest, string)	Získá pracovní položky pro seznam ID pracovních položek (maximálně 200)
getWorkItemStateColors(string[])	POUZE INTERNÍ: Bude použit pro pracovní zkušenosti s mým účtem. Získání barvy stavu typu pracovní položky pro více projektů
getWorkItemTemplate(string, string, string, Date, WorkItemExpand)	Vrátí jednu pracovní položku ze šablony.
getWorkItemType(string, string)	Vrátí definici typu pracovní položky.
getWorkItemTypeCategories(string)	Získejte všechny kategorie typů pracovních položek.
getWorkItemTypeCategory(string, string)	Získejte konkrétní kategorii typu pracovní položky podle názvu.
getWorkItemTypeColorAndIcons(string[])	POUZE INTERNÍ: Používá se pro poskytovatele barev a ikon. Získejte barvu typu vtipu pro více projektů
getWorkItemTypeColors(string[])	POUZE INTERNÍ: Bude použit pro pracovní zkušenosti s mým účtem. Získejte barvu typu vtipu pro více projektů
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)	Získejte seznam polí pro typ pracovní položky s podrobnými odkazy.
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)	Získejte pole pro typ pracovní položky s podrobnými odkazy.
getWorkItemTypes(string)	Vrátí seznam typů pracovních položek
getWorkItemTypeStates(string, string)	Vrátí názvy stavů a barvy pro typ pracovní položky.
queryById(string, string, string, boolean, number)	Získá výsledky dotazu s daným ID dotazu.
queryByWiql(Wiql, string, string, boolean, number)	Získá výsledky dotazu vzhledem k jeho WIQL.
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)	Dotazuje se na pracovní položky propojené s daným seznamem identifikátorů URI artefaktů.
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)	Získejte dávku revizí pracovních položek s možností zahrnutí odstraněných položek
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)	Získejte dávku revizí pracovních položek. Tento požadavek lze použít, pokud je váš seznam polí dostatečně velký, aby mohl spustit adresu URL nad limit délky.
replaceTemplate(WorkItemTemplate, string, string, string)	Nahrazení obsahu předlohy
restoreWorkItem(WorkItemDeleteUpdate, number, string)	Obnoví odstraněnou pracovní položku z koše.
searchQueries(string, string, number, QueryExpand, boolean)	Prohledá všechny dotazy, ke kterým má uživatel přístup v aktuálním projektu
sendMail(SendMailBody, string)	Metoda RESTful pro odesílání pošty pro vybrané/dotazované pracovní položky.
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Aktualizujte existující uzel klasifikace.
updateField(UpdateWorkItemField, string, string)	Aktualizujte pole.
updateQuery(QueryHierarchyItem, string, string, boolean)	Aktualizujte dotaz nebo složku. To vám umožní aktualizovat, přejmenovávat a přesouvat dotazy a složky.
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)	Aktualizuje jednu pracovní položku.
updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)	Přidání nebo aktualizace typu pracovní položky

Podrobnosti konstruktoru

WorkItemTrackingRestClient(IVssRestClientOptions)

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

Podrobnosti vlastnosti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Hodnota vlastnosti

string

Podrobnosti metody

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

Nahraje přílohu.

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

Parametry

content: any

Obsah k nahrání

project: string

ID projektu nebo název projektu

fileName: string

Název souboru

uploadType: string

Typ nahrání přílohy: Jednoduchý nebo blokovaný

areaPath: string

Cílový projekt Oblast Cesta

Návraty

Promise<AttachmentReference>

createField(WorkItemField, string)

Vytvořte nové pole.

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

Parametry

workItemField: WorkItemField

Nová definice pole

project: string

ID projektu nebo název projektu

Návraty

Promise<WorkItemField>

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Vytvořte nový nebo aktualizujte existující uzel klasifikace.

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

Parametry

postedNode: WorkItemClassificationNode

Uzel, který chcete vytvořit nebo aktualizovat.

project: string

ID projektu nebo název projektu

structureGroup: TreeStructureGroup

Skupina Struktura klasifikačního uzlu, oblasti nebo iterace.

path: string

Cesta klasifikačního uzlu.

Návraty

Promise<WorkItemClassificationNode>

createQuery(QueryHierarchyItem, string, string, boolean)

Vytvoří dotaz nebo přesune dotaz.

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

Parametry

postedQuery: QueryHierarchyItem

Dotaz, který se má vytvořit.

project: string

ID projektu nebo název projektu

query: string

ID nadřazeného objektu nebo cesta, pod kterou má být dotaz vytvořen.

validateWiqlOnly: boolean

Pokud chcete dotaz WIQL pouze ověřit, aniž byste jej skutečně vytvořili, nastavte jej na hodnotu true. Výchozí hodnota je False.

Návraty

Promise<QueryHierarchyItem>

createTemplate(WorkItemTemplate, string, string)

Vytvoří šablonu

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

Parametry

template: WorkItemTemplate

Obsah šablony

project: string

ID projektu nebo název projektu

team: string

ID týmu nebo název týmu

Návraty

Promise<WorkItemTemplate>

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

Vytvoří jednu pracovní položku.

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

Parametry

document: JsonPatchDocument

Dokument opravy JSON představující pracovní položku

project: string

ID projektu nebo název projektu

type: string

Typ pracovní položky pracovní položky, která má být vytvořena

validateOnly: boolean

Označte, zda chcete pouze ověřit změny bez uložení pracovní položky

bypassRules: boolean

Nevynucujte pravidla typu pracovní položky v této aktualizaci

suppressNotifications: boolean

Nespouštějte žádná oznámení o této změně

expand: WorkItemExpand

Rozbalí parametry pro atributy pracovních položek. Možné možnosti jsou { Žádné, Vztahy, Pole, Odkazy, Všechny }.

Návraty

Promise<WorkItem>

deleteClassificationNode(string, TreeStructureGroup, string, number)

Odstraňte existující uzel klasifikace.

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

Parametry

project: string

ID projektu nebo název projektu

structureGroup: TreeStructureGroup

Skupina Struktura klasifikačního uzlu, oblasti nebo iterace.

path: string

Cesta klasifikačního uzlu.

reclassifyId: number

Id cílového uzlu klasifikace pro reklasifikaci.

Návraty

Promise<void>

deleteField(string, string)

Odstraní pole. Chcete-li obnovit smazaný soubor, přečtěte si článek Rozhraní API "Aktualizovat pole".

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

Parametry

fieldNameOrRefName: string

Jednoduchý název pole nebo název odkazu

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

deleteQuery(string, string)

Odstraňte dotaz nebo složku. Tím se odstraní všechny změny oprávnění u odstraněného dotazu nebo složky a všech jejích potomků, pokud se jedná o složku. Je důležité si uvědomit, že odstraněné změny oprávnění nelze po obnovení dotazu nebo složky obnovit.

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

Parametry

project: string

ID projektu nebo název projektu

query: string

ID nebo cesta dotazu nebo složky, kterou chcete odstranit.

Návraty

Promise<void>

deleteTemplate(string, string, string)

Smaže šablonu se zadaným id

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

Parametry

project: string

ID projektu nebo název projektu

team: string

ID týmu nebo název týmu

templateId: string

ID šablony

Návraty

Promise<void>

deleteWorkItem(number, string, boolean)

Odstraní zadanou pracovní položku a odešle ji do koše, aby ji bylo možné v případě potřeby obnovit zpět. Volitelně, pokud byl parametr destroy nastaven na hodnotu true, zničí pracovní položku trvale. UPOZORNĚNÍ: Pokud je parametr destroy nastaven na hodnotu true, pracovní položky odstraněné tímto příkazem NEPŘEJDOU do koše a neexistuje způsob, jak je po odstranění obnovit nebo obnovit. Tento parametr se nedoporučuje používat. Pokud tak učiníte, používejte tento parametr s maximální opatrností.

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

Parametry

id: number

ID pracovní položky, která má být odstraněna

project: string

ID projektu nebo název projektu

destroy: boolean

Volitelný parametr, pokud je nastavený na true, pracovní položka se trvale odstraní. Vezměte prosím na vědomí: akce zničení je TRVALÁ a nelze ji vrátit zpět.

Návraty

Promise<WorkItemDelete>

destroyWorkItem(number, string)

Trvale zničí zadanou pracovní položku z koše. Tuto akci nelze vrátit zpět.

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

Parametry

id: number

ID pracovní položky, která má být trvale zničena

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

exportWorkItemTypeDefinition(string, string, boolean)

Export typu pracovní položky

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

Parametry

project: string

ID projektu nebo název projektu

type: string

exportGlobalLists: boolean

Návraty

Promise<WorkItemTypeTemplate>

getAccountMyWorkData(QueryOption)

POUZE INTERNÍ: POUŽÍVÁ SE ÚČET MOJE PRACOVNÍ STRÁNKA. Tím se vrátí podrobnosti o pracovních položkách Dělám, Hotovo, Sleduje a aktivita.

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

Parametry

queryOption: QueryOption

Návraty

Promise<AccountMyWorkResult>

getAttachmentContent(string, string, string, boolean)

Stáhne přílohu.

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

Parametry

id: string

ID přílohy

project: string

ID projektu nebo název projektu

fileName: string

Název souboru

download: boolean

Pokud je nastavená hodnota <c>true</c> , vždy stáhnout přílohu

Návraty

Promise<ArrayBuffer>

getAttachmentZip(string, string, string, boolean)

Stáhne přílohu.

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

Parametry

id: string

ID přílohy

project: string

ID projektu nebo název projektu

fileName: string

Název souboru

download: boolean

Pokud je nastavená hodnota <c>true</c> , vždy stáhnout přílohu

Návraty

Promise<ArrayBuffer>

getClassificationNode(string, TreeStructureGroup, string, number)

Získá klasifikační uzel pro danou cestu uzlu.

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

Parametry

project: string

ID projektu nebo název projektu

structureGroup: TreeStructureGroup

Skupina Struktura klasifikačního uzlu, oblasti nebo iterace.

path: string

Cesta klasifikačního uzlu.

depth: number

Hloubka potomků k načtení.

Návraty

Promise<WorkItemClassificationNode>

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

Získá kořenové klasifikační uzly nebo seznam klasifikačních uzlů pro daný seznam ID uzlů pro daný projekt. V případě, že je zadán parametr ids, získáte seznam klasifikačních uzlů pro tato id. V opačném případě získáte kořenové klasifikační uzly pro tento projekt.

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

Parametry

project: string

ID projektu nebo název projektu

ids: number[]

ID uzlů celočíselné klasifikace oddělené čárkami. Není to nutné, pokud chcete kořenové uzly.

depth: number

Hloubka potomků k načtení.

errorPolicy: ClassificationNodesErrorPolicy

Příznak pro zpracování chyb při získávání některých uzlů. Možné možnosti jsou Selhat a Vynechat.

Návraty

Promise<WorkItemClassificationNode[]>

getComment(number, number, string)

Získá komentář k pracovní položce v zadané revizi.

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

Parametry

id: number

ID pracovní položky

revision: number

Revize, pro kterou je třeba načíst komentář

project: string

ID projektu nebo název projektu

Návraty

Promise<WorkItemComment>

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

Získá zadaný počet komentářů pro pracovní položku ze zadané revize.

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

Parametry

id: number

ID pracovní položky

project: string

ID projektu nebo název projektu

fromRevision: number

Revize, ze které se mají poznámky načítat (výchozí je 1)

top: number

Počet komentářů, které se mají vrátit (výchozí je 200)

order: CommentSortOrder

Vzestupně nebo sestupně podle ID revize (výchozí je vzestupně)

Návraty

Promise<WorkItemComments>

getDeletedWorkItem(number, string)

Získá odstraněnou pracovní položku z koše.

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

Parametry

id: number

ID pracovní položky, která má být vrácena

project: string

ID projektu nebo název projektu

Návraty

Promise<WorkItemDelete>

getDeletedWorkItems(number[], string)

Získá pracovní položky z koše, jejichž ID byla zadána v parametrech

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

Parametry

ids: number[]

Čárkami oddělený seznam ID odstraněných pracovních položek, které mají být vráceny

project: string

ID projektu nebo název projektu

Návraty

Promise<WorkItemDeleteReference[]>

getDeletedWorkItemShallowReferences(string)

Získá seznam ID a adres URL odstraněných pracovních položek v koši.

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

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<WorkItemDeleteShallowReference[]>

getField(string, string)

Získá informace o určitém poli.

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

Parametry

fieldNameOrRefName: string

Jednoduchý název pole nebo název odkazu

project: string

ID projektu nebo název projektu

Návraty

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

Vrací informace pro všechna pole. Parametr ID/name projektu je volitelný.

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

Parametry

project: string

ID projektu nebo název projektu

expand: GetFieldsExpand

Použijte ExtensionFields k zahrnutí polí rozšíření, jinak je vyloučte. Pokud není příznak funkce pro tento parametr povolen, jsou pole rozšíření vždy zahrnuta.

Návraty

Promise<WorkItemField[]>

getQueries(string, QueryExpand, number, boolean)

Získá kořenové dotazy a jejich podřízené dotazy

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

Parametry

project: string

ID projektu nebo název projektu

expand: QueryExpand

Do výsledků zahrňte řetězec dotazu (wiql), klauzule, sloupce výsledků dotazu a možnosti řazení.

depth: number

Ve složce dotazů vraťte podřízené dotazy a složky do této hloubky.

includeDeleted: boolean

Zahrnout odstraněné dotazy a složky

Návraty

Promise<QueryHierarchyItem[]>

getQueriesBatch(QueryBatchGetRequest, string)

Získá seznam dotazů podle id (maximálně 1000)

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

Parametry

queryGetRequest: QueryBatchGetRequest

project: string

ID projektu nebo název projektu

Návraty

Promise<QueryHierarchyItem[]>

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

Načte jednotlivý dotaz a jeho podřízené položky

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

Parametry

project: string

ID projektu nebo název projektu

query: string

ID nebo cesta dotazu.

expand: QueryExpand

Do výsledků zahrňte řetězec dotazu (wiql), klauzule, sloupce výsledků dotazu a možnosti řazení.

depth: number

Ve složce dotazů vraťte podřízené dotazy a složky do této hloubky.

includeDeleted: boolean

Zahrnout odstraněné dotazy a složky

useIsoDateFormat: boolean

Klauzule dotazu DateTime budou formátovány pomocí formátu kompatibilního s normou ISO 8601

Návraty

Promise<QueryHierarchyItem>

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

Získá výsledky dotazu s daným ID dotazu.

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

Parametry

id: string

ID dotazu.

project: string

ID projektu nebo název projektu

team: string

ID týmu nebo název týmu

timePrecision: boolean

Zda použít přesnost času.

top: number

Maximální počet výsledků, které se mají vrátit.

Návraty

Promise<number>

getRecentActivityData()

Získá nedávné aktivity pracovních položek

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Návraty

Promise<AccountRecentActivityWorkItemModel2[]>

getRecentMentions()

POUZE INTERNÍ: POUŽÍVÁ SE ÚČET MOJE PRACOVNÍ STRÁNKA.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Návraty

Promise<AccountRecentMentionWorkItemModel[]>

getRelationType(string)

Získá definici typu vztahu pracovní položky.

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

Parametry

relation: string

Název relace

Návraty

Promise<WorkItemRelationType>

getRelationTypes()

Získá typy vztahů pracovních položek.

function getRelationTypes(): Promise<WorkItemRelationType[]>

Návraty

Promise<WorkItemRelationType[]>

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

Získání dávky odkazů na pracovní položky

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

Parametry

project: string

ID projektu nebo název projektu

linkTypes: string[]

Seznam typů pro filtrování výsledků podle konkrétních typů odkazů. Vynecháním tohoto parametru získáte odkazy na pracovní položky všech typů odkazů.

types: string[]

Seznam typů pro filtrování výsledků na konkrétní typy pracovních položek. Vynecháním tohoto parametru získáte odkazy na pracovní položky všech typů pracovních položek.

continuationToken: string

Určuje vlastnost continuationToken, ze které se má dávka spustit. Vynecháním tohoto parametru získáte první dávku odkazů.

startDateTime: Date

Datum a čas, který se má použít jako výchozí bod pro změny odkazu. Vrátí se pouze změny odkazu, ke kterým došlo po tomto datu a čase. Nelze použít ve spojení s parametrem 'watermark'.

Návraty

Promise<ReportingWorkItemLinksBatch>

getRevision(number, number, string, WorkItemExpand)

Vrátí plně hydratovanou pracovní položku pro požadovanou revizi

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

Parametry

id: number

revisionNumber: number

project: string

ID projektu nebo název projektu

expand: WorkItemExpand

Návraty

Promise<WorkItem>

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

Vrátí seznam plně hydratovaných revizí pracovních položek, stránkovaných.

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

Parametry

id: number

project: string

ID projektu nebo název projektu

top: number

skip: number

expand: WorkItemExpand

Návraty

Promise<WorkItem[]>

getRootNodes(string, number)

Získá kořenové klasifikační uzly v rámci projektu.

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

Parametry

project: string

ID projektu nebo název projektu

depth: number

Hloubka potomků k načtení.

Návraty

Promise<WorkItemClassificationNode[]>

getTemplate(string, string, string)

Získá šablonu se zadaným id

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

Parametry

project: string

ID projektu nebo název projektu

team: string

ID týmu nebo název týmu

templateId: string

ID šablony

Návraty

Promise<WorkItemTemplate>

getTemplates(string, string, string)

Získá šablonu

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

Parametry

project: string

ID projektu nebo název projektu

team: string

ID týmu nebo název týmu

workitemtypename: string

Volitelné, pokud je zadáno vrátí šablony pro daný typ pracovní položky.

Návraty

Promise<WorkItemTemplateReference[]>

getUpdate(number, number, string)

Vrátí jednu aktualizaci pracovní položky

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

Parametry

id: number

updateNumber: number

project: string

ID projektu nebo název projektu

Návraty

Promise<WorkItemUpdate>

getUpdates(number, string, number, number)

Vrátí rozdíly mezi revizemi pracovních položek

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

Parametry

id: number

project: string

ID projektu nebo název projektu

top: number

skip: number

Návraty

Promise<WorkItemUpdate[]>

getWorkArtifactLinkTypes()

Získejte seznam typů odkazů na odchozí artefakty sledujících pracovní položky.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

Návraty

Promise<WorkArtifactLink[]>

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

Vrátí jednu pracovní položku.

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

Parametry

id: number

ID pracovní položky

project: string

ID projektu nebo název projektu

fields: string[]

Seznam požadovaných polí oddělených čárkami

asOf: Date

Řetězec data a času AsOf UTC

expand: WorkItemExpand

Rozbalí parametry pro atributy pracovních položek. Možné možnosti jsou { Žádné, Vztahy, Pole, Odkazy, Všechny }.

Návraty

Promise<WorkItem>

getWorkItemIconJson(string, string, number)

Získejte ikonu pracovní položky s popisným názvem a barvou ikony.

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

Parametry

icon: string

Název ikony

color: string

6místná hexadecimální barva ikony

v: number

Verze ikony (používá se pouze pro zneplatnění mezipaměti)

Návraty

Promise<WorkItemIcon>

getWorkItemIcons()

Získejte seznam všech ikon pracovních položek.

function getWorkItemIcons(): Promise<WorkItemIcon[]>

Návraty

Promise<WorkItemIcon[]>

getWorkItemIconSvg(string, string, number)

Získejte ikonu pracovní položky s popisným názvem a barvou ikony.

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

Parametry

icon: string

Název ikony

color: string

6místná hexadecimální barva ikony

v: number

Verze ikony (používá se pouze pro zneplatnění mezipaměti)

Návraty

Promise<any>

getWorkItemIconXaml(string, string, number)

Získejte ikonu pracovní položky s popisným názvem a barvou ikony.

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

Parametry

icon: string

Název ikony

color: string

6místná hexadecimální barva ikony

v: number

Verze ikony (používá se pouze pro zneplatnění mezipaměti)

Návraty

Promise<any>

getWorkItemNextStatesOnCheckinAction(number[], string)

Vrátí další stav na daných ID pracovních položek.

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

Parametry

ids: number[]

Seznam ID pracovních položek

action: string

možných akcí. V současné době podporuje pouze vrácení se změnami

Návraty

Promise<WorkItemNextStateOnTransition[]>

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

Vrátí seznam pracovních položek (maximálně 200).

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

Parametry

ids: number[]

Seznam požadovaných ID pracovních položek oddělených čárkami. (Povoleno je maximálně 200 ID).

project: string

ID projektu nebo název projektu

fields: string[]

Seznam požadovaných polí oddělených čárkami

asOf: Date

Řetězec data a času AsOf UTC

expand: WorkItemExpand

Rozbalí parametry pro atributy pracovních položek. Možné možnosti jsou { Žádné, Vztahy, Pole, Odkazy, Všechny }.

errorPolicy: WorkItemErrorPolicy

Příznak pro řízení chybových zásad v žádosti o hromadné získání pracovních položek. Možné možnosti jsou {Fail, Vynechat}.

Návraty

Promise<WorkItem[]>

getWorkItemsBatch(WorkItemBatchGetRequest, string)

Získá pracovní položky pro seznam ID pracovních položek (maximálně 200)

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

Parametry

workItemGetRequest: WorkItemBatchGetRequest

project: string

ID projektu nebo název projektu

Návraty

Promise<WorkItem[]>

getWorkItemStateColors(string[])

POUZE INTERNÍ: Bude použit pro pracovní zkušenosti s mým účtem. Získání barvy stavu typu pracovní položky pro více projektů

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

Parametry

projectNames: string[]

Návraty

Promise<ProjectWorkItemStateColors[]>

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

Vrátí jednu pracovní položku ze šablony.

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

Parametry

project: string

ID projektu nebo název projektu

type: string

Název typu pracovní položky

fields: string

Seznam požadovaných polí oddělených čárkami

asOf: Date

Řetězec data a času AsOf UTC

expand: WorkItemExpand

Rozbalí parametry pro atributy pracovních položek. Možné možnosti jsou { Žádné, Vztahy, Pole, Odkazy, Všechny }.

Návraty

Promise<WorkItem>

getWorkItemType(string, string)

Vrátí definici typu pracovní položky.

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

Parametry

project: string

ID projektu nebo název projektu

type: string

Název typu pracovní položky

Návraty

Promise<WorkItemType>

getWorkItemTypeCategories(string)

Získejte všechny kategorie typů pracovních položek.

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

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<WorkItemTypeCategory[]>

getWorkItemTypeCategory(string, string)

Získejte konkrétní kategorii typu pracovní položky podle názvu.

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

Parametry

project: string

ID projektu nebo název projektu

category: string

Název kategorie

Návraty

Promise<WorkItemTypeCategory>

getWorkItemTypeColorAndIcons(string[])

POUZE INTERNÍ: Používá se pro poskytovatele barev a ikon. Získejte barvu typu vtipu pro více projektů

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

Parametry

projectNames: string[]

Návraty

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

getWorkItemTypeColors(string[])

POUZE INTERNÍ: Bude použit pro pracovní zkušenosti s mým účtem. Získejte barvu typu vtipu pro více projektů

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

Parametry

projectNames: string[]

Návraty

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

getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)

Získejte seznam polí pro typ pracovní položky s podrobnými odkazy.

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

Parametry

project: string

ID projektu nebo název projektu

type: string

Typ pracovní položky.

expand: WorkItemTypeFieldsExpandLevel

Rozbalte úroveň odpovědi rozhraní API. Vlastnosti: zahrnout allowedvalues, default value, isRequired atd. jako součást odpovědi; Žádné: pro přeskočení těchto vlastností.

Návraty

Promise<WorkItemTypeFieldWithReferences[]>

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

Získejte pole pro typ pracovní položky s podrobnými odkazy.

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

Parametry

project: string

ID projektu nebo název projektu

type: string

Typ pracovní položky.

field: string

expand: WorkItemTypeFieldsExpandLevel

Rozbalte úroveň odpovědi rozhraní API. Vlastnosti: zahrnout allowedvalues, default value, isRequired atd. jako součást odpovědi; Žádné: pro přeskočení těchto vlastností.

Návraty

Promise<WorkItemTypeFieldWithReferences>

getWorkItemTypes(string)

Vrátí seznam typů pracovních položek

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

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<WorkItemType[]>

getWorkItemTypeStates(string, string)

Vrátí názvy stavů a barvy pro typ pracovní položky.

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

Parametry

project: string

ID projektu nebo název projektu

type: string

Název státu

Návraty

Promise<WorkItemStateColor[]>

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

Získá výsledky dotazu s daným ID dotazu.

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

Parametry

id: string

ID dotazu.

project: string

ID projektu nebo název projektu

team: string

ID týmu nebo název týmu

timePrecision: boolean

Zda použít přesnost času.

top: number

Maximální počet výsledků, které se mají vrátit.

Návraty

Promise<WorkItemQueryResult>

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

Získá výsledky dotazu vzhledem k jeho WIQL.

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

Parametry

wiql: Wiql

Dotaz obsahující soubor WIQL.

project: string

ID projektu nebo název projektu

team: string

ID týmu nebo název týmu

timePrecision: boolean

Zda použít přesnost času.

top: number

Maximální počet výsledků, které se mají vrátit.

Návraty

Promise<WorkItemQueryResult>

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

Dotazuje se na pracovní položky propojené s daným seznamem identifikátorů URI artefaktů.

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

Parametry

artifactUriQuery: ArtifactUriQuery

Definuje seznam identifikátorů URI artefaktů pro dotazování na pracovní položky.

project: string

ID projektu nebo název projektu

Návraty

Promise<ArtifactUriQueryResult>

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

Získejte dávku revizí pracovních položek s možností zahrnutí odstraněných položek

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>

Parametry

project: string

ID projektu nebo název projektu

fields: string[]

Seznam polí, která mají být vrácena v revizích pracovních položek. Vynecháním tohoto parametru získáte všechna pole podléhající hlášení.

types: string[]

Seznam typů pro filtrování výsledků na konkrétní typy pracovních položek. Vynecháním tohoto parametru získáte revize pracovních položek všech typů pracovních položek.

continuationToken: string

Určuje vodoznak, od kterého se má dávka spustit. Vynecháním tohoto parametru získáte první dávku revizí.

startDateTime: Date

Datum a čas, které se má použít jako výchozí bod pro revize, všechny revize proběhnou po tomto datu a čase. Nelze použít ve spojení s parametrem 'watermark'.

includeIdentityRef: boolean

Vrátí odkaz na identitu namísto řetězcové hodnoty pro pole identity.

includeDeleted: boolean

Určete, zda má být odstraněná položka vrácena.

includeTagRef: boolean

Určete, zda mají být vráceny objekty značek pro pole System.Tags.

includeLatestOnly: boolean

Vrátit pouze nejnovější revize pracovních položek a přeskočit všechny historické revize

expand: ReportingRevisionsExpand

Vrátí všechna pole v revizích pracovních položek, včetně dlouhých textových polí, která nejsou ve výchozím nastavení vrácena

includeDiscussionChangesOnly: boolean

Vrátí pouze ty revize pracovních položek, u kterých bylo změněno pouze pole historie

maxPageSize: number

Maximální počet výsledků, které mají být vráceny v této dávce

Návraty

Promise<ReportingWorkItemRevisionsBatch>

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

Získejte dávku revizí pracovních položek. Tento požadavek lze použít, pokud je váš seznam polí dostatečně velký, aby mohl spustit adresu URL nad limit délky.

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

Parametry

filter: ReportingWorkItemRevisionsFilter

Objekt, který obsahuje nastavení požadavku: filtr polí, filtr typu, formát identity

project: string

ID projektu nebo název projektu

continuationToken: string

Určuje vodoznak, od kterého se má dávka spustit. Vynecháním tohoto parametru získáte první dávku revizí.

startDateTime: Date

Datum a čas, které se má použít jako výchozí bod pro revize, všechny revize proběhnou po tomto datu a čase. Nelze použít ve spojení s parametrem 'watermark'.

expand: ReportingRevisionsExpand

Návraty

Promise<ReportingWorkItemRevisionsBatch>

replaceTemplate(WorkItemTemplate, string, string, string)

Nahrazení obsahu předlohy

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

Parametry

templateContent: WorkItemTemplate

Obsah šablony, kterou se má nahradit

project: string

ID projektu nebo název projektu

team: string

ID týmu nebo název týmu

templateId: string

ID šablony

Návraty

Promise<WorkItemTemplate>

restoreWorkItem(WorkItemDeleteUpdate, number, string)

Obnoví odstraněnou pracovní položku z koše.

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

Parametry

payload: WorkItemDeleteUpdate

Paylod s pokyny k aktualizaci příznaku IsDeleted na false

id: number

ID pracovní položky, která má být obnovena

project: string

ID projektu nebo název projektu

Návraty

Promise<WorkItemDelete>

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

Prohledá všechny dotazy, ke kterým má uživatel přístup v aktuálním projektu

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

Parametry

project: string

ID projektu nebo název projektu

filter: string

Text, podle kterého se mají dotazy filtrovat.

top: number

Počet dotazů, které se mají vrátit (výchozí je 50 a maximum je 200).

expand: QueryExpand

includeDeleted: boolean

Zahrnout odstraněné dotazy a složky

Návraty

Promise<QueryHierarchyItemsResult>

sendMail(SendMailBody, string)

Metoda RESTful pro odesílání pošty pro vybrané/dotazované pracovní položky.

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

Parametry

body: SendMailBody

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Aktualizujte existující uzel klasifikace.

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

Parametry

postedNode: WorkItemClassificationNode

Uzel, který chcete vytvořit nebo aktualizovat.

project: string

ID projektu nebo název projektu

structureGroup: TreeStructureGroup

Skupina Struktura klasifikačního uzlu, oblasti nebo iterace.

path: string

Cesta klasifikačního uzlu.

Návraty

Promise<WorkItemClassificationNode>

updateField(UpdateWorkItemField, string, string)

Aktualizujte pole.

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

Parametry

payload: UpdateWorkItemField

Datová část obsahuje požadovanou hodnotu vlastností pole

fieldNameOrRefName: string

Název/referenční název pole, které má být aktualizováno

project: string

ID projektu nebo název projektu

Návraty

Promise<WorkItemField>

updateQuery(QueryHierarchyItem, string, string, boolean)

Aktualizujte dotaz nebo složku. To vám umožní aktualizovat, přejmenovávat a přesouvat dotazy a složky.

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

Parametry

queryUpdate: QueryHierarchyItem

Dotaz, který se má aktualizovat.

project: string

ID projektu nebo název projektu

query: string

ID nebo cesta k aktualizaci dotazu.

undeleteDescendants: boolean

Obnovte smazání podřízených položek této složky. Je důležité si uvědomit, že se tím nevrátí změny oprávnění, které byly dříve aplikovány na potomky.

Návraty

Promise<QueryHierarchyItem>

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

Aktualizuje jednu pracovní položku.

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

Parametry

document: JsonPatchDocument

Dokument opravy JSON představující aktualizaci

id: number

ID pracovní položky, která se má aktualizovat

project: string

ID projektu nebo název projektu

validateOnly: boolean

Označte, zda chcete pouze ověřit změny bez uložení pracovní položky

bypassRules: boolean

Nevynucujte pravidla typu pracovní položky v této aktualizaci

suppressNotifications: boolean

Nespouštějte žádná oznámení o této změně

expand: WorkItemExpand

Rozbalí parametry pro atributy pracovních položek. Možné možnosti jsou { Žádné, Vztahy, Pole, Odkazy, Všechny }.

Návraty

Promise<WorkItem>

updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)

Přidání nebo aktualizace typu pracovní položky

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

Parametry

updateModel: WorkItemTypeTemplateUpdateModel

project: string

ID projektu nebo název projektu

Návraty

Promise<ProvisioningResult>

Váš názor

Byla tato stránka užitečná?

Sdílet prostřednictvím

WorkItemTrackingRestClient class

Konstruktory

Vlastnosti

Metody

Podrobnosti konstruktoru

WorkItemTrackingRestClient(IVssRestClientOptions)

Parametry

Podrobnosti vlastnosti

RESOURCE_AREA_ID

Hodnota vlastnosti

Podrobnosti metody

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

Parametry

Návraty

createField(WorkItemField, string)

Parametry

Návraty

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Parametry

Návraty

createQuery(QueryHierarchyItem, string, string, boolean)

Parametry

Návraty

createTemplate(WorkItemTemplate, string, string)

Parametry

Návraty

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

Parametry

Návraty

deleteClassificationNode(string, TreeStructureGroup, string, number)

Parametry

Návraty

deleteField(string, string)

Parametry

Návraty

deleteQuery(string, string)

Parametry

Návraty

deleteTemplate(string, string, string)

Parametry

Návraty

deleteWorkItem(number, string, boolean)

Parametry

Návraty

destroyWorkItem(number, string)

Parametry

Návraty

exportWorkItemTypeDefinition(string, string, boolean)

Parametry

Návraty

getAccountMyWorkData(QueryOption)

Parametry

Návraty

getAttachmentContent(string, string, string, boolean)

Parametry

Návraty

getAttachmentZip(string, string, string, boolean)

Parametry

Návraty

getClassificationNode(string, TreeStructureGroup, string, number)

Parametry

Návraty

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

Parametry

Návraty

getComment(number, number, string)

Parametry

Návraty

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

Parametry

Návraty

getDeletedWorkItem(number, string)

Parametry

Návraty

getDeletedWorkItems(number[], string)

Parametry

Návraty

getDeletedWorkItemShallowReferences(string)

Parametry