WorkItemTrackingRestClient class

Reference

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

Základní třída, která by se měla používat (odvozená z) k vytváření požadavků na rozhraní REST api služby VSS

Extends: RestClientBase

Konstruktory

WorkItemTrackingRestClient(IVssRestClientOptions)

Vlastnosti

RESOURCE_AREA_ID

Metody

createAttachment(any, string, string, string, string)	Odešle 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. Pokud chcete zrušit odstranění souboru, přečtěte si téma o rozhraní API aktualizace pole.
deleteQuery(string, string)	Odstraňte dotaz nebo složku. Tím se odstraní všechny změny oprávnění odstraněného dotazu nebo složky a všechny jejich potomky, pokud se jedná o složku. Je důležité si uvědomit, že odstraněné změny oprávnění nelze obnovit po zrušení odeslání dotazu nebo složky.
deleteTemplate(string, string, string)	Odstraní š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 je parametr destroy nastaven na hodnotu true, pracovní položku trvale zničí. 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 po odstranění neexistuje žádný způsob, jak je obnovit nebo obnovit. Tento parametr se doporučuje NEPOUŽÍVAT. Pokud ano, používejte tento parametr s mimořádnou 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 NA STRÁNCE ÚČET MOJE PRÁCE. Vrátí se podrobnosti o pracovních položkách Doing, Done, Follows a activity.
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á uzel klasifikace pro danou cestu uzlu.
getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)	Získá kořenové klasifikační uzly nebo seznam uzlů klasifikace pro daný seznam uzlů ID pro daný projekt. V případě, že je zadán parametr ids, získáte seznam uzlů klasifikace pro tato ID. V opačném případě získáte uzly kořenové klasifikace pro tento projekt.
getComment(number, number, string)	Získá komentář pro pracovní položku 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 konkrétním poli.
getFields(string, GetFieldsExpand)	Vrátí informace pro všechna pole. Parametr ID/název projektu je volitelný.
getQueries(string, QueryExpand, number, boolean)	Získá kořenové dotazy a jejich podřízené položky.
getQueriesBatch(QueryBatchGetRequest, string)	Získá seznam dotazů podle ID (maximálně 1000)
getQuery(string, string, QueryExpand, number, boolean, boolean)	Načte jednotlivé dotazy a jeho podřízené položky.
getQueryResultCount(string, string, string, boolean, number)	Získá výsledky dotazu dané ID dotazu.
getRecentActivityData()	Získá nedávné aktivity pracovních položek.
getRecentMentions()	POUZE INTERNÍ: POUŽÍVÁ SE NA STRÁNCE ÚČET MOJE PRÁCE.
getRelationType(string)	Získá definici typu relace pracovní položky.
getRelationTypes()	Získá typy relací 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 se stránkou.
getRootNodes(string, number)	Získá uzly kořenové klasifikace 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 pro pracovní položku.
getUpdates(number, string, number, number)	Vrátí rozdíly mezi revizemi pracovních položek.
getWorkArtifactLinkTypes()	Získejte seznam typů odkazů artefaktů pro sledování odchozích položek.
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 pro daná 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Í: Použije se pro pracovní prostředí pro můj účet. 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íská všechny kategorie typů pracovních položek.
getWorkItemTypeCategory(string, string)	Získejte kategorii konkrétního typu pracovní položky podle názvu.
getWorkItemTypeColorAndIcons(string[])	POUZE INTERNÍ: Používá se pro poskytovatele barev a ikon. Získání barvy typu wit pro více projektů
getWorkItemTypeColors(string[])	POUZE INTERNÍ: Použije se pro pracovní prostředí pro můj účet. Získání barvy typu wit pro více projektů
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)	Získání seznamu polí pro typ pracovní položky s podrobnými odkazy
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)	Získání 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 států a barvy pro typ pracovní položky.
queryById(string, string, string, boolean, number)	Získá výsledky dotazu dané ID dotazu.
queryByWiql(Wiql, string, string, boolean, number)	Získá výsledky dotazu z jeho WIQL.
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)	Dotazuje se na pracovní položky propojené s daným seznamem identifikátoru URI artefaktů.
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)	Získání dávky 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 se může použít v případě, že je seznam polí dostatečně velký, aby mohl adresu URL spouštět přes limit délky.
replaceTemplate(WorkItemTemplate, string, string, string)	Nahradit obsah šablony
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á uživatel přístup v aktuálním projektu.
sendMail(SendMailBody, string)	Metoda RESTful pro odeslání pošty pro vybrané nebo dotazované pracovní položky
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Aktualizace existujícího uzlu klasifikace
updateField(UpdateWorkItemField, string, string)	Aktualizace pole
updateQuery(QueryHierarchyItem, string, string, boolean)	Aktualizace dotazu nebo složky To vám umožní aktualizovat, přejmenovat a přesunout dotazy a složky.
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)	Aktualizace 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)

Odešle 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 odeslání přílohy: Jednoduché nebo Blokované

areaPath: string

Cesta oblasti cílového projektu

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 struktury klasifikačního uzlu, oblasti nebo iterace.

path: string

Cesta uzlu klasifikace.

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ý chcete vytvořit.

project: string

ID projektu nebo název projektu

query: string

ID nadřazeného objektu nebo cesta, pod kterou se má dotaz vytvořit.

validateWiqlOnly: boolean

Pokud chcete pouze ověřit dotaz WIQL, aniž byste ho skutečně vytvořili, nastavte ho na 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 JSON Patch představující pracovní položku

project: string

ID projektu nebo název projektu

type: string

Typ pracovní položky, kterou chcete vytvořit

validateOnly: boolean

Uveďte, jestli chcete jenom ověřit změny bez uložení pracovní položky.

bypassRules: boolean

Nevynucovat pravidla typu pracovní položky u této aktualizace

suppressNotifications: boolean

Pro tuto změnu neaktivujte žádná oznámení.

expand: WorkItemExpand

Rozbalení parametrů pro atributy pracovní položky. Možné možnosti jsou { None, Relations, Fields, Links, All }.

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 struktury klasifikačního uzlu, oblasti nebo iterace.

path: string

Cesta uzlu klasifikace.

reclassifyId: number

ID cílového klasifikačního uzlu pro reklasifikaci.

Návraty

Promise<void>

deleteField(string, string)

Odstraní pole. Pokud chcete zrušit odstranění souboru, přečtěte si téma o rozhraní API aktualizace 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í odstraněného dotazu nebo složky a všechny jejich potomky, pokud se jedná o složku. Je důležité si uvědomit, že odstraněné změny oprávnění nelze obnovit po zrušení odeslání dotazu nebo složky.

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

Parametry

project: string

ID projektu nebo název projektu

query: string

ID nebo cesta k dotazu nebo složce, které chcete odstranit.

Návraty

Promise<void>

deleteTemplate(string, string, string)

Odstraní š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 je parametr destroy nastaven na hodnotu true, pracovní položku trvale zničí. 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 po odstranění neexistuje žádný způsob, jak je obnovit nebo obnovit. Tento parametr se doporučuje NEPOUŽÍVAT. Pokud ano, používejte tento parametr s mimořádnou 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á hodnota true, pracovní položka se trvale odstraní. Poznámka: Akce zničení je PERMANENT 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 NA STRÁNCE ÚČET MOJE PRÁCE. Vrátí se podrobnosti o pracovních položkách Doing, Done, Follows a activity.

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áhněte 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áhněte přílohu.

Návraty

Promise<ArrayBuffer>

getClassificationNode(string, TreeStructureGroup, string, number)

Získá uzel klasifikace 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 struktury klasifikačního uzlu, oblasti nebo iterace.

path: string

Cesta uzlu klasifikace.

depth: number

Hloubka dětí, které se mají načíst.

Návraty

Promise<WorkItemClassificationNode>

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

Získá kořenové klasifikační uzly nebo seznam uzlů klasifikace pro daný seznam uzlů ID pro daný projekt. V případě, že je zadán parametr ids, získáte seznam uzlů klasifikace pro tato ID. V opačném případě získáte uzly kořenové klasifikace 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ých čárkami Pokud chcete kořenové uzly, není to nutné.

depth: number

Hloubka dětí, které se mají načíst.

errorPolicy: ClassificationNodesErrorPolicy

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

Návraty

Promise<WorkItemClassificationNode[]>

getComment(number, number, string)

Získá komentář pro pracovní položku 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 potř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í načíst komentáře (výchozí hodnota je 1)

top: number

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

order: CommentSortOrder

Vzestupně nebo sestupně podle ID revize (výchozí hodnota 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á se má vrátit

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é se mají vrátit

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 konkrétní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)

Vrátí informace pro všechna pole. Parametr ID/název 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í rozšiřujících polí, jinak je vyluč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é položky.

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

Zahrnutí odstraněných dotazů a složek

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é dotazy 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

Zahrnutí odstraněných dotazů a složek

useIsoDateFormat: boolean

Klauzule dotazu DateTime budou formátovány pomocí formátu kompatibilního se standardem ISO 8601.

Návraty

Promise<QueryHierarchyItem>

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

Získá výsledky dotazu dané 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 se má použít časová přesnost nebo ne.

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 NA STRÁNCE ÚČET MOJE PRÁCE.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Návraty

Promise<AccountRecentMentionWorkItemModel[]>

getRelationType(string)

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

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

Parametry

relation: string

Název relace

Návraty

Promise<WorkItemRelationType>

getRelationTypes()

Získá typy relací 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ů na konkrétní typy odkazů. Pokud chcete získat odkazy na pracovní položky všech typů odkazů, tento parametr vynecháte.

types: string[]

Seznam typů pro filtrování výsledků na konkrétní typy pracovních položek. Pokud chcete získat odkazy na pracovní položky všech typů pracovních položek, tento parametr vynecháte.

continuationToken: string

Určuje continuationToken, ze které se má dávka spustit. Pokud chcete získat první dávku odkazů, tento parametr vynecháte.

startDateTime: Date

Datum a čas, který se použije jako výchozí bod pro změny propojení. Vrátí se pouze změny propojení, 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 se stránkou.

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á uzly kořenové klasifikace v rámci projektu.

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

Parametry

project: string

ID projektu nebo název projektu

depth: number

Hloubka dětí, které se mají načíst.

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 pro pracovní položku.

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ů artefaktů pro sledování odchozích položek.

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 ve formátu UTC

expand: WorkItemExpand

Rozbalení parametrů pro atributy pracovní položky. Možné možnosti jsou { None, Relations, Fields, Links, All }.

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

Šestimístná šestnáctková 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

Šestimístná šestnáctková 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

Šestimístná šestnáctková 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 pro daná 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é akce. Aktuálně podporuje jenom 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 id požadovaných pracovních položek oddělených čárkami. (Je povoleno 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 ve formátu UTC

expand: WorkItemExpand

Rozbalení parametrů pro atributy pracovní položky. Možné možnosti jsou { None, Relations, Fields, Links, All }.

errorPolicy: WorkItemErrorPolicy

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

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Í: Použije se pro pracovní prostředí pro můj účet. 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 ve formátu UTC

expand: WorkItemExpand

Rozbalení parametrů pro atributy pracovní položky. Možné možnosti jsou { None, Relations, Fields, Links, All }.

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íská 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 kategorii konkrétního 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ískání barvy typu wit 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Í: Použije se pro pracovní prostředí pro můj účet. Získání barvy typu wit 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ískání seznamu 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 povolené hodnoty, výchozí hodnotu, isRequired atd. jako součást odpovědi; Žádné: Tyto vlastnosti se přeskočí.

Návraty

Promise<WorkItemTypeFieldWithReferences[]>

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

Získání 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 povolené hodnoty, výchozí hodnotu, isRequired atd. jako součást odpovědi; Žádné: Tyto vlastnosti se přeskočí.

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 států 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 dané 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 se má použít časová přesnost nebo ne.

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 z jeho WIQL.

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

Parametry

wiql: Wiql

Dotaz obsahující wiql.

project: string

ID projektu nebo název projektu

team: string

ID týmu nebo název týmu

timePrecision: boolean

Zda se má použít časová přesnost nebo ne.

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átoru URI artefaktů.

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

Parametry

artifactUriQuery: ArtifactUriQuery

Definuje seznam identifikátoru URI artefaktů pro dotazování pracovních položek.

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ískání dávky 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á se mají vrátit v revizích pracovních položek. Pokud chcete získat všechna pole s možnou sestavou, tento parametr vynecháte.

types: string[]

Seznam typů pro filtrování výsledků na konkrétní typy pracovních položek. Pokud chcete získat revize pracovních položek všech typů pracovních položek, tento parametr vynecháte.

continuationToken: string

Určuje vodoznak, ze které se má dávka spustit. Pokud chcete získat první dávku revizí, tento parametr vynecháte.

startDateTime: Date

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

includeIdentityRef: boolean

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

includeDeleted: boolean

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

includeTagRef: boolean

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

includeLatestOnly: boolean

Vrácení pouze nejnovějších revizí pracovních položek, přeskočení všech historických revizí

expand: ReportingRevisionsExpand

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

includeDiscussionChangesOnly: boolean

Vrátit pouze revize pracovních položek, kde se změnilo pouze pole historie.

maxPageSize: number

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

Návraty

Promise<ReportingWorkItemRevisionsBatch>

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

Získejte dávku revizí pracovních položek. Tento požadavek se může použít v případě, že je seznam polí dostatečně velký, aby mohl adresu URL spouštět přes 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 typů, formát identity

project: string

ID projektu nebo název projektu

continuationToken: string

Určuje vodoznak, ze které se má dávka spustit. Pokud chcete získat první dávku revizí, tento parametr vynecháte.

startDateTime: Date

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

expand: ReportingRevisionsExpand

Návraty

Promise<ReportingWorkItemRevisionsBatch>

replaceTemplate(WorkItemTemplate, string, string, string)

Nahradit obsah šablony

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

Parametry

templateContent: WorkItemTemplate

Obsah šablony, za který 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á se má obnovit

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á 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, pomocí který chcete filtrovat dotazy.

top: number

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

expand: QueryExpand

includeDeleted: boolean

Zahrnutí odstraněných dotazů a složek

Návraty

Promise<QueryHierarchyItemsResult>

sendMail(SendMailBody, string)

Metoda RESTful pro odeslání pošty pro vybrané nebo 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)

Aktualizace existujícího uzlu 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 struktury klasifikačního uzlu, oblasti nebo iterace.

path: string

Cesta uzlu klasifikace.

Návraty

Promise<WorkItemClassificationNode>

updateField(UpdateWorkItemField, string, string)

Aktualizace 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 nebo název odkazu pole, které se má aktualizovat

project: string

ID projektu nebo název projektu

Návraty

Promise<WorkItemField>

updateQuery(QueryHierarchyItem, string, string, boolean)

Aktualizace dotazu nebo složky To vám umožní aktualizovat, přejmenovat a přesunout 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 dotazu, který se má aktualizovat.

undeleteDescendants: boolean

Zrušíte odstraně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 použity u potomků.

Návraty

Promise<QueryHierarchyItem>

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

Aktualizace 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

Uveďte, jestli chcete pouze ověřit změny bez uložení pracovní položky.

bypassRules: boolean

Nevynucovat pravidla typu pracovní položky u této aktualizace

suppressNotifications: boolean

Pro tuto změnu neaktivujte žádná oznámení.

expand: WorkItemExpand

Parametry rozbalení pro atributy pracovní položky Možné možnosti jsou { None, Relations, Fields, Links, All }.

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>

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