WorkItemTrackingRestClient class

Csomag:: azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni

Extends: RestClientBase

Konstruktorok

WorkItemTrackingRestClient(IVssRestClientOptions)

Tulajdonságok

Metódusok

createAttachment(any, string, string, string, string)	Feltölt egy mellékletet.
createField(WorkItemField, string)	Hozzon létre egy új mezőt.
createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Hozzon létre új besorolási csomópontot, vagy frissítsen egy meglévő besorolási csomópontot.
createQuery(QueryHierarchyItem, string, string, boolean)	Lekérdezést hoz létre, vagy áthelyez egy lekérdezést.
createTemplate(WorkItemTemplate, string, string)	Sablont hoz létre
createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)	Egyetlen munkaelemet hoz létre.
deleteClassificationNode(string, TreeStructureGroup, string, number)	Meglévő besorolási csomópont törlése.
deleteField(string, string)	Törli a mezőt. A fájl törlésének visszavonásához tekintse meg a "Mező frissítése" API-t.
deleteQuery(string, string)	Lekérdezés vagy mappa törlése. Ezzel törli a törölt lekérdezés vagy mappa, valamint annak leszármazottai engedélymódosításait, ha az mappa. Fontos megjegyezni, hogy a törölt engedélymódosítások nem állíthatók vissza a lekérdezés vagy mappa törlésének visszavonásakor.
deleteTemplate(string, string, string)	Törli a sablont a megadott azonosítóval
deleteWorkItem(number, string, boolean)	Törli a megadott munkaelemet, és elküldi a Lomtárba, hogy szükség esetén visszaállítható legyen. Ha a destroy paraméter true (igaz) értékre van állítva, akkor véglegesen megsemmisíti a munkaelemet. FIGYELEM: Ha a destroy paraméter true (igaz) értékre van állítva, a paranccsal törölt munkaelemek NEM kerülnek a lomtárba, és a törlés után nincs mód a visszaállításukra/helyreállításukra. Javasoljuk, hogy NE használja ezt a paramétert. Ha igen, kérjük, használja ezt a paramétert rendkívül óvatosan.
destroyWorkItem(number, string)	Véglegesen megsemmisíti a megadott munkaelemet a Lomtárból. Ez a művelet nem vonható vissza.
exportWorkItemTypeDefinition(string, string, boolean)	Munkaelem-típus exportálása
getAccountMyWorkData(QueryOption)	CSAK BELSŐ: A FIÓK SAJÁT MUNKAHELYI LAPJA HASZNÁLJA. Ez visszaadja a Doing, a Done, a Follows és a tevékenység munkaelemeinek részleteit.
getAttachmentContent(string, string, string, boolean)	Letölt egy mellékletet.
getAttachmentZip(string, string, string, boolean)	Letölt egy mellékletet.
getClassificationNode(string, TreeStructureGroup, string, number)	Lekéri egy adott csomópont elérési útjának besorolási csomópontját.
getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)	Lekéri a gyökérbesorolási csomópontokat vagy a besorolási csomópontok listáját egy adott csomópontazonosítók adott listájához egy adott projekthez. Ha a paraméter meg van adva, megkapja az ids besorolási csomópontjainak listáját. Ellenkező esetben gyökérbesorolási csomópontokat kap ehhez a projekthez.
getComment(number, number, string)	Megjegyzést kap egy munkaelemhez a megadott változatban.
getComments(number, string, number, number, CommentSortOrder)	Lekéri a megadott számú megjegyzést egy munkaelemhez a megadott változatból.
getDeletedWorkItem(number, string)	Lekér egy törölt munkaelemet a Lomtárból.
getDeletedWorkItems(number[], string)	Lekéri a munkaelemeket a lomtárból, amelynek azonosítói meg vannak adva a paraméterekben
getDeletedWorkItemShallowReferences(string)	Lekéri a Lomtárban lévő törölt munkaelemek azonosítóinak és URL-címeinek listáját.
getField(string, string)	Információkat kap egy adott mezőről.
getFields(string, GetFieldsExpand)	Az összes mező adatait adja vissza. A projektazonosító/név paraméter megadása nem kötelező.
getQueries(string, QueryExpand, number, boolean)	Lekéri a gyökérlekérdezéseket és azok gyermekeit
getQueriesBatch(QueryBatchGetRequest, string)	Lekérdezések listáját azonosítók szerint kéri le (legfeljebb 1000)
getQuery(string, string, QueryExpand, number, boolean, boolean)	Lekér egy egyedi lekérdezést és annak gyermekeit
getQueryResultCount(string, string, string, boolean, number)	Lekéri a lekérdezés eredményét a lekérdezés azonosítója alapján.
getRecentActivityData()	Lekéri a legutóbbi munkaelem-tevékenységeket
getRecentMentions()	CSAK BELSŐ: A FIÓK SAJÁT MUNKAHELYI LAPJA HASZNÁLJA.
getRelationType(string)	Lekéri a munkaelem kapcsolattípusának definícióját.
getRelationTypes()	Lekéri a munkaelem kapcsolattípusait.
getReportingLinksByLinkType(string, string[], string[], string, Date)	Munkaelem-hivatkozások kötegének lekérése
getRevision(number, number, string, WorkItemExpand)	Teljesen hidratált munkaelemet ad vissza a kért változathoz
getRevisions(number, string, number, number, WorkItemExpand)	A teljesen hidratált munkaelem-módosítások listáját adja vissza.
getRootNodes(string, number)	Lekéri a gyökérbesorolási csomópontokat a projekt alatt.
getTemplate(string, string, string)	Lekéri a sablont a megadott azonosítóval
getTemplates(string, string, string)	Lekéri a sablont
getUpdate(number, number, string)	Egyetlen frissítést ad vissza egy munkaelemhez
getUpdates(number, string, number, number)	A munkaelemek módosításai közötti különbözeteket adja vissza
getWorkArtifactLinkTypes()	Szerezze be a munkaelemek nyomon követésének kimenő összetevő-hivatkozástípusainak listáját.
getWorkItem(number, string, string[], Date, WorkItemExpand)	Egyetlen munkaelemet ad vissza.
getWorkItemIconJson(string, string, number)	Szerezzen be egy munkaelem ikont a rövid név és az ikon színe alapján.
getWorkItemIcons()	Az összes munkaelem-ikon listájának lekérése.
getWorkItemIconSvg(string, string, number)	Szerezzen be egy munkaelem ikont a rövid név és az ikon színe alapján.
getWorkItemIconXaml(string, string, number)	Szerezzen be egy munkaelem ikont a rövid név és az ikon színe alapján.
getWorkItemNextStatesOnCheckinAction(number[], string)	A megadott munkaelem-azonosítók következő állapotát adja vissza.
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)	Munkaelemek listáját adja vissza (legfeljebb 200)
getWorkItemsBatch(WorkItemBatchGetRequest, string)	Munkaelemek lekérése a munkaelem-azonosítók listájához (legfeljebb 200)
getWorkItemStateColors(string[])	CSAK BELSŐ: A fiókom munkatapasztalatához lesz használva. A munkaelemtípus állapotszínének lekérése több projekthez
getWorkItemTemplate(string, string, string, Date, WorkItemExpand)	Egyetlen munkaelemet ad vissza egy sablonból.
getWorkItemType(string, string)	Munkaelemtípus-definíciót ad vissza.
getWorkItemTypeCategories(string)	Az összes munkaelemtípus-kategória lekérése.
getWorkItemTypeCategory(string, string)	Adott munkaelemtípus-kategória lekérése név szerint.
getWorkItemTypeColorAndIcons(string[])	CSAK BELSŐ: Szín- és ikonszolgáltatókhoz használják. Szerezze be a wit típus színét több projekthez
getWorkItemTypeColors(string[])	CSAK BELSŐ: A fiókom munkatapasztalatához lesz használva. Szerezze be a wit típus színét több projekthez
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)	Szerezze be a munkaelem-típus mezőinek listáját részletes hivatkozásokkal.
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)	Szerezzen be egy mezőt egy munkaelem-típushoz részletes hivatkozásokkal.
getWorkItemTypes(string)	A munkaelemtípusok listáját adja vissza
getWorkItemTypeStates(string, string)	Egy munkaelemtípus állapotnevét és színét adja vissza.
queryById(string, string, string, boolean, number)	Lekéri a lekérdezés eredményét a lekérdezés azonosítója alapján.
queryByWiql(Wiql, string, string, boolean, number)	Lekéri a lekérdezés eredményeit a WIQL alapján.
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)	Lekérdezi az összetevő URI-jának adott listájához csatolt munkaelemeket.
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)	Munkaelem-módosítások kötegének lekérése a törölt elemek belefoglalásának lehetőségével
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)	Szerezzen be egy köteg munkaelem-módosítást. Ez a kérés akkor használható, ha a mezők listája elég nagy ahhoz, hogy az URL-címet a hosszkorláton túl futtathassa.
replaceTemplate(WorkItemTemplate, string, string, string)	Sablon tartalmának cseréje
restoreWorkItem(WorkItemDeleteUpdate, number, string)	Visszaállítja a törölt munkaelemet a Lomtárból.
searchQueries(string, string, number, QueryExpand, boolean)	Megkeresi az összes lekérdezést, amelyhez a felhasználó hozzáfér az aktuális projektben
sendMail(SendMailBody, string)	RESTful metódus a kijelölt/lekérdezett munkaelemek e-mailjeinek küldésére.
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Meglévő besorolási csomópont frissítése.
updateField(UpdateWorkItemField, string, string)	Mező frissítése.
updateQuery(QueryHierarchyItem, string, string, boolean)	Lekérdezés vagy mappa frissítése. Ez lehetővé teszi a lekérdezések és mappák frissítését, átnevezését és áthelyezését.
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)	Egyetlen munkaelemet frissít.
updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)	Munkaelem-típus hozzáadása/frissítése

Konstruktor adatai

WorkItemTrackingRestClient(IVssRestClientOptions)

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

Paraméterek

options: IVssRestClientOptions

Tulajdonság adatai

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Tulajdonság értéke

string

Metódus adatai

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

Feltölt egy mellékletet.

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

Paraméterek

content: any

Feltöltendő tartalom

project: string

Projektazonosító vagy projektnév

fileName: string

A fájl neve

uploadType: string

Melléklet feltöltésének típusa: Egyszerű vagy Darabolt

areaPath: string

Célprojekt terület Útvonal

Válaszok

Promise<AttachmentReference>

createField(WorkItemField, string)

Hozzon létre egy új mezőt.

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

Paraméterek

workItemField: WorkItemField

Új meződefiníció

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<WorkItemField>

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Hozzon létre új besorolási csomópontot, vagy frissítsen egy meglévő besorolási csomópontot.

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

Paraméterek

postedNode: WorkItemClassificationNode

Csomópont létrehozásához vagy frissítéséhez.

project: string

Projektazonosító vagy projektnév

structureGroup: TreeStructureGroup

Az osztályozási csomópont, terület vagy iteráció struktúracsoportja.

path: string

A besorolási csomópont elérési útja.

Válaszok

Promise<WorkItemClassificationNode>

createQuery(QueryHierarchyItem, string, string, boolean)

Lekérdezést hoz létre, vagy áthelyez egy lekérdezést.

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

Paraméterek

postedQuery: QueryHierarchyItem

A létrehozandó lekérdezés.

project: string

Projektazonosító vagy projektnév

query: string

A lekérdezés létrehozásának szülőazonosítója vagy elérési útja.

validateWiqlOnly: boolean

Ha csak a WIQL-lekérdezést szeretné érvényesíteni anélkül, hogy ténylegesen létrehozna egyet, állítsa igaz értékre. Az alapértelmezett érték false.

Válaszok

Promise<QueryHierarchyItem>

createTemplate(WorkItemTemplate, string, string)

Sablont hoz létre

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

Paraméterek

template: WorkItemTemplate

Sablon tartalma

project: string

Projektazonosító vagy projektnév

team: string

Csapatazonosító vagy csapatnév

Válaszok

Promise<WorkItemTemplate>

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

Egyetlen munkaelemet hoz létre.

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

Paraméterek

document: JsonPatchDocument

A munkaelemet képviselő JSON Patch dokumentum

project: string

Projektazonosító vagy projektnév

type: string

A létrehozni kívánt munkaelem munkaelemtípusa

validateOnly: boolean

Jelezze, hogy csak a munkaelem mentése nélkül szeretné-e érvényesíteni a módosításokat

bypassRules: boolean

A munkaelem-típusszabályok kényszerítésének mellőzése ezen a frissítésen

suppressNotifications: boolean

Ne küldjön értesítést erről a módosításról

expand: WorkItemExpand

A munkaelem-attribútumok paramétereinek kibontása. A lehetséges opciók a következők: { Nincs, Kapcsolatok, Mezők, Hivatkozások, Összes }.

Válaszok

Promise<WorkItem>

deleteClassificationNode(string, TreeStructureGroup, string, number)

Meglévő besorolási csomópont törlése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

structureGroup: TreeStructureGroup

Az osztályozási csomópont, terület vagy iteráció struktúracsoportja.

path: string

A besorolási csomópont elérési útja.

reclassifyId: number

Az újrabesoroláshoz szükséges célbesorolási csomópont azonosítója.

Válaszok

Promise<void>

deleteField(string, string)

Törli a mezőt. A fájl törlésének visszavonásához tekintse meg a "Mező frissítése" API-t.

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

Paraméterek

fieldNameOrRefName: string

Mező egyszerű neve vagy hivatkozási neve

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<void>

deleteQuery(string, string)

Lekérdezés vagy mappa törlése. Ezzel törli a törölt lekérdezés vagy mappa, valamint annak leszármazottai engedélymódosításait, ha az mappa. Fontos megjegyezni, hogy a törölt engedélymódosítások nem állíthatók vissza a lekérdezés vagy mappa törlésének visszavonásakor.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

query: string

A törölni kívánt lekérdezés vagy mappa azonosítója vagy elérési útja.

Válaszok

Promise<void>

deleteTemplate(string, string, string)

Törli a sablont a megadott azonosítóval

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

Paraméterek

project: string

Projektazonosító vagy projektnév

team: string

Csapatazonosító vagy csapatnév

templateId: string

Sablon azonosítója

Válaszok

Promise<void>

deleteWorkItem(number, string, boolean)

Törli a megadott munkaelemet, és elküldi a Lomtárba, hogy szükség esetén visszaállítható legyen. Ha a destroy paraméter true (igaz) értékre van állítva, akkor véglegesen megsemmisíti a munkaelemet. FIGYELEM: Ha a destroy paraméter true (igaz) értékre van állítva, a paranccsal törölt munkaelemek NEM kerülnek a lomtárba, és a törlés után nincs mód a visszaállításukra/helyreállításukra. Javasoljuk, hogy NE használja ezt a paramétert. Ha igen, kérjük, használja ezt a paramétert rendkívül óvatosan.

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

Paraméterek

id: number

A törölni kívánt munkaelem azonosítója

project: string

Projektazonosító vagy projektnév

destroy: boolean

Nem kötelező paraméter, ha igaz értékre van állítva, a munkaelem véglegesen törlődik. Kérjük, vedd figyelembe: a megsemmisítés művelet VÉGLEGES és nem vonható vissza.

Válaszok

Promise<WorkItemDelete>

destroyWorkItem(number, string)

Véglegesen megsemmisíti a megadott munkaelemet a Lomtárból. Ez a művelet nem vonható vissza.

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

Paraméterek

id: number

A véglegesen megsemmisítendő munkaelem azonosítója

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<void>

exportWorkItemTypeDefinition(string, string, boolean)

Munkaelem-típus exportálása

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

Paraméterek

project: string

Projektazonosító vagy projektnév

type: string

exportGlobalLists: boolean

Válaszok

Promise<WorkItemTypeTemplate>

getAccountMyWorkData(QueryOption)

CSAK BELSŐ: A FIÓK SAJÁT MUNKAHELYI LAPJA HASZNÁLJA. Ez visszaadja a Doing, a Done, a Follows és a tevékenység munkaelemeinek részleteit.

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

Paraméterek

queryOption: QueryOption

Válaszok

Promise<AccountMyWorkResult>

getAttachmentContent(string, string, string, boolean)

Letölt egy mellékletet.

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

Paraméterek

id: string

Melléklet azonosítója

project: string

Projektazonosító vagy projektnév

fileName: string

A fájl neve

download: boolean

Ha c>true</c> értékre <van állítva, mindig töltse le a mellékletet

Válaszok

Promise<ArrayBuffer>

getAttachmentZip(string, string, string, boolean)

Letölt egy mellékletet.

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

Paraméterek

id: string

Melléklet azonosítója

project: string

Projektazonosító vagy projektnév

fileName: string

A fájl neve

download: boolean

Ha c>true</c> értékre <van állítva, mindig töltse le a mellékletet

Válaszok

Promise<ArrayBuffer>

getClassificationNode(string, TreeStructureGroup, string, number)

Lekéri egy adott csomópont elérési útjának besorolási csomópontját.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

structureGroup: TreeStructureGroup

Az osztályozási csomópont, terület vagy iteráció struktúracsoportja.

path: string

A besorolási csomópont elérési útja.

depth: number

Az elhozandó gyermekek mélysége.

Válaszok

Promise<WorkItemClassificationNode>

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

Lekéri a gyökérbesorolási csomópontokat vagy a besorolási csomópontok listáját egy adott csomópontazonosítók adott listájához egy adott projekthez. Ha a paraméter meg van adva, megkapja az ids besorolási csomópontjainak listáját. Ellenkező esetben gyökérbesorolási csomópontokat kap ehhez a projekthez.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

ids: number[]

Vesszővel elválasztott egész szám besorolási csomópontok azonosítói. Nem kötelező, ha gyökércsomópontokat szeretne.

depth: number

Az elhozandó gyermekek mélysége.

errorPolicy: ClassificationNodesErrorPolicy

Jelölje meg a csomópontok lekérésével kapcsolatos hibák kezelését. A lehetséges lehetőségek a Sikertelen és a Kihagyás.

Válaszok

Promise<WorkItemClassificationNode[]>

getComment(number, number, string)

Megjegyzést kap egy munkaelemhez a megadott változatban.

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

Paraméterek

id: number

Munkaelem azonosítója

revision: number

Változat, amelyhez a megjegyzést le kell kérni

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<WorkItemComment>

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

Lekéri a megadott számú megjegyzést egy munkaelemhez a megadott változatból.

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

Paraméterek

id: number

Munkaelem azonosítója

project: string

Projektazonosító vagy projektnév

fromRevision: number

Változat, amelyből a megjegyzéseket le kell kérni (alapértelmezett 1)

top: number

A visszaadandó megjegyzések száma (alapértelmezett 200)

order: CommentSortOrder

Növekvő vagy csökkenő változatazonosító szerint (az alapértelmezett érték növekvő)

Válaszok

Promise<WorkItemComments>

getDeletedWorkItem(number, string)

Lekér egy törölt munkaelemet a Lomtárból.

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

Paraméterek

id: number

A visszaküldendő munkaelem azonosítója

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<WorkItemDelete>

getDeletedWorkItems(number[], string)

Lekéri a munkaelemeket a lomtárból, amelynek azonosítói meg vannak adva a paraméterekben

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

Paraméterek

ids: number[]

A visszaadandó törölt munkaelemek azonosítóinak vesszővel tagolt listája

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<WorkItemDeleteReference[]>

getDeletedWorkItemShallowReferences(string)

Lekéri a Lomtárban lévő törölt munkaelemek azonosítóinak és URL-címeinek listáját.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<WorkItemDeleteShallowReference[]>

getField(string, string)

Információkat kap egy adott mezőről.

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

Paraméterek

fieldNameOrRefName: string

Mező egyszerű neve vagy hivatkozási neve

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

Az összes mező adatait adja vissza. A projektazonosító/név paraméter megadása nem kötelező.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

expand: GetFieldsExpand

Az ExtensionFields használatával bővítménymezőket is belefoglalhat, ellenkező esetben kizárhatja őket. Ha a paraméter funkciójelzője nincs engedélyezve, a bővítménymezők mindig szerepelnek.

Válaszok

Promise<WorkItemField[]>

getQueries(string, QueryExpand, number, boolean)

Lekéri a gyökérlekérdezéseket és azok gyermekeit

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

Paraméterek

project: string

Projektazonosító vagy projektnév

expand: QueryExpand

Az eredmények között szerepeltesse a lekérdezési sztringet (wiql), a záradékokat, a lekérdezési eredményoszlopokat és a rendezési beállításokat.

depth: number

A lekérdezések mappájában adja vissza a gyermeklekérdezéseket és mappákat erre a mélységre.

includeDeleted: boolean

Törölt lekérdezések és mappák belefoglalása

Válaszok

Promise<QueryHierarchyItem[]>

getQueriesBatch(QueryBatchGetRequest, string)

Lekérdezések listáját azonosítók szerint kéri le (legfeljebb 1000)

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

Paraméterek

queryGetRequest: QueryBatchGetRequest

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<QueryHierarchyItem[]>

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

Lekér egy egyedi lekérdezést és annak gyermekeit

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

Paraméterek

project: string

Projektazonosító vagy projektnév

query: string

A lekérdezés azonosítója vagy elérési útja.

expand: QueryExpand

Az eredmények között szerepeltesse a lekérdezési sztringet (wiql), a záradékokat, a lekérdezési eredményoszlopokat és a rendezési beállításokat.

depth: number

A lekérdezések mappájában adja vissza a gyermeklekérdezéseket és mappákat erre a mélységre.

includeDeleted: boolean

Törölt lekérdezések és mappák belefoglalása

useIsoDateFormat: boolean

A DateTime lekérdezési záradékok formázása ISO 8601-kompatibilis formátumban történik

Válaszok

Promise<QueryHierarchyItem>

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

Lekéri a lekérdezés eredményét a lekérdezés azonosítója alapján.

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

Paraméterek

id: string

A lekérdezés azonosítója.

project: string

Projektazonosító vagy projektnév

team: string

Csapatazonosító vagy csapatnév

timePrecision: boolean

Használjunk-e időpontosságot vagy sem.

top: number

A visszaadandó eredmények maximális száma.

Válaszok

Promise<number>

getRecentActivityData()

Lekéri a legutóbbi munkaelem-tevékenységeket

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Válaszok

Promise<AccountRecentActivityWorkItemModel2[]>

getRecentMentions()

CSAK BELSŐ: A FIÓK SAJÁT MUNKAHELYI LAPJA HASZNÁLJA.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Válaszok

Promise<AccountRecentMentionWorkItemModel[]>

getRelationType(string)

Lekéri a munkaelem kapcsolattípusának definícióját.

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

Paraméterek

relation: string

A reláció neve

Válaszok

Promise<WorkItemRelationType>

getRelationTypes()

Lekéri a munkaelem kapcsolattípusait.

function getRelationTypes(): Promise<WorkItemRelationType[]>

Válaszok

Promise<WorkItemRelationType[]>

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

Munkaelem-hivatkozások kötegének lekérése

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

Paraméterek

project: string

Projektazonosító vagy projektnév

linkTypes: string[]

Azon típusok listája, amelyek az eredményeket adott hivatkozástípusokra szűrhetik. Hagyja ki ezt a paramétert az összes hivatkozástípus munkaelem-hivatkozásainak lekéréséhez.

types: string[]

Az eredmények adott munkaelemtípusokra való szűrésére szolgáló típusok listája. Hagyja ki ezt a paramétert az összes munkaelem-típus munkaelem-hivatkozásainak lekéréséhez.

continuationToken: string

Megadja azt a continuationTokent, amelyből a köteget el kell indítani. Hagyja ki ezt a paramétert a hivatkozások első kötegének lekéréséhez.

startDateTime: Date

A hivatkozásmódosítások kiindulópontjaként használandó dátum/idő. Csak az adott dátum/időpont után történt hivatkozásmódosításokat adja vissza. Nem használható együtt a "vízjel" paraméterrel.

Válaszok

Promise<ReportingWorkItemLinksBatch>

getRevision(number, number, string, WorkItemExpand)

Teljesen hidratált munkaelemet ad vissza a kért változathoz

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

Paraméterek

id: number

revisionNumber: number

project: string

Projektazonosító vagy projektnév

expand: WorkItemExpand

Válaszok

Promise<WorkItem>

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

A teljesen hidratált munkaelem-módosítások listáját adja vissza.

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

Paraméterek

id: number

project: string

Projektazonosító vagy projektnév

top: number

skip: number

expand: WorkItemExpand

Válaszok

Promise<WorkItem[]>

getRootNodes(string, number)

Lekéri a gyökérbesorolási csomópontokat a projekt alatt.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

depth: number

Az elhozandó gyermekek mélysége.

Válaszok

Promise<WorkItemClassificationNode[]>

getTemplate(string, string, string)

Lekéri a sablont a megadott azonosítóval

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

Paraméterek

project: string

Projektazonosító vagy projektnév

team: string

Csapatazonosító vagy csapatnév

templateId: string

Sablon azonosítója

Válaszok

Promise<WorkItemTemplate>

getTemplates(string, string, string)

Lekéri a sablont

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

Paraméterek

project: string

Projektazonosító vagy projektnév

team: string

Csapatazonosító vagy csapatnév

workitemtypename: string

Nem kötelező, ha meg van adva, sablonokat ad vissza az adott munkaelem-típushoz.

Válaszok

Promise<WorkItemTemplateReference[]>

getUpdate(number, number, string)

Egyetlen frissítést ad vissza egy munkaelemhez

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

Paraméterek

id: number

updateNumber: number

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<WorkItemUpdate>

getUpdates(number, string, number, number)

A munkaelemek módosításai közötti különbözeteket adja vissza

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

Paraméterek

id: number

project: string

Projektazonosító vagy projektnév

top: number

skip: number

Válaszok

Promise<WorkItemUpdate[]>

getWorkArtifactLinkTypes()

Szerezze be a munkaelemek nyomon követésének kimenő összetevő-hivatkozástípusainak listáját.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

Válaszok

Promise<WorkArtifactLink[]>

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

Egyetlen munkaelemet ad vissza.

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

Paraméterek

id: number

A munkaelem azonosítója

project: string

Projektazonosító vagy projektnév

fields: string[]

A kért mezők vesszővel tagolt listája

asOf: Date

AsOf UTC dátum idő karakterlánc

expand: WorkItemExpand

A munkaelem-attribútumok paramétereinek kibontása. A lehetséges opciók a következők: { Nincs, Kapcsolatok, Mezők, Hivatkozások, Összes }.

Válaszok

Promise<WorkItem>

getWorkItemIconJson(string, string, number)

Szerezzen be egy munkaelem ikont a rövid név és az ikon színe alapján.

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

Paraméterek

icon: string

Az ikon neve

color: string

Az ikon 6 számjegyű hexadecimális színe

v: number

Az ikon verziója (csak a gyorsítótár érvénytelenítésére szolgál)

Válaszok

Promise<WorkItemIcon>

getWorkItemIcons()

Az összes munkaelem-ikon listájának lekérése.

function getWorkItemIcons(): Promise<WorkItemIcon[]>

Válaszok

Promise<WorkItemIcon[]>

getWorkItemIconSvg(string, string, number)

Szerezzen be egy munkaelem ikont a rövid név és az ikon színe alapján.

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

Paraméterek

icon: string

Az ikon neve

color: string

Az ikon 6 számjegyű hexadecimális színe

v: number

Az ikon verziója (csak a gyorsítótár érvénytelenítésére szolgál)

Válaszok

Promise<any>

getWorkItemIconXaml(string, string, number)

Szerezzen be egy munkaelem ikont a rövid név és az ikon színe alapján.

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

Paraméterek

icon: string

Az ikon neve

color: string

Az ikon 6 számjegyű hexadecimális színe

v: number

Az ikon verziója (csak a gyorsítótár érvénytelenítésére szolgál)

Válaszok

Promise<any>

getWorkItemNextStatesOnCheckinAction(number[], string)

A megadott munkaelem-azonosítók következő állapotát adja vissza.

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

Paraméterek

ids: number[]

Munkaelem-azonosítók listája

action: string

lehetséges intézkedések. Jelenleg csak a bejelentkezést támogatja

Válaszok

Promise<WorkItemNextStateOnTransition[]>

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

Munkaelemek listáját adja vissza (legfeljebb 200)

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

Paraméterek

ids: number[]

A kért munkaelem-azonosítók vesszővel tagolt listája. (Legfeljebb 200 azonosító engedélyezett).

project: string

Projektazonosító vagy projektnév

fields: string[]

A kért mezők vesszővel tagolt listája

asOf: Date

AsOf UTC dátum idő karakterlánc

expand: WorkItemExpand

A munkaelem-attribútumok paramétereinek kibontása. A lehetséges opciók a következők: { Nincs, Kapcsolatok, Mezők, Hivatkozások, Összes }.

errorPolicy: WorkItemErrorPolicy

A hibaszabályzat szabályozására szolgáló jelző egy tömeges munkaelem-kérelemben. A lehetséges lehetőségek a következők: {Fail, Mellőzés}.

Válaszok

Promise<WorkItem[]>

getWorkItemsBatch(WorkItemBatchGetRequest, string)

Munkaelemek lekérése a munkaelem-azonosítók listájához (legfeljebb 200)

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

Paraméterek

workItemGetRequest: WorkItemBatchGetRequest

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<WorkItem[]>

getWorkItemStateColors(string[])

CSAK BELSŐ: A fiókom munkatapasztalatához lesz használva. A munkaelemtípus állapotszínének lekérése több projekthez

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

Paraméterek

projectNames: string[]

Válaszok

Promise<ProjectWorkItemStateColors[]>

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

Egyetlen munkaelemet ad vissza egy sablonból.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

type: string

A munkaelem típusának neve

fields: string

A kért mezők vesszővel tagolt listája

asOf: Date

AsOf UTC dátum idő karakterlánc

expand: WorkItemExpand

A munkaelem-attribútumok paramétereinek kibontása. A lehetséges opciók a következők: { Nincs, Kapcsolatok, Mezők, Hivatkozások, Összes }.

Válaszok

Promise<WorkItem>

getWorkItemType(string, string)

Munkaelemtípus-definíciót ad vissza.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

type: string

Munkaelem típusának neve

Válaszok

Promise<WorkItemType>

getWorkItemTypeCategories(string)

Az összes munkaelemtípus-kategória lekérése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<WorkItemTypeCategory[]>

getWorkItemTypeCategory(string, string)

Adott munkaelemtípus-kategória lekérése név szerint.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

category: string

A kategória neve

Válaszok

Promise<WorkItemTypeCategory>

getWorkItemTypeColorAndIcons(string[])

CSAK BELSŐ: Szín- és ikonszolgáltatókhoz használják. Szerezze be a wit típus színét több projekthez

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

Paraméterek

projectNames: string[]

Válaszok

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

getWorkItemTypeColors(string[])

CSAK BELSŐ: A fiókom munkatapasztalatához lesz használva. Szerezze be a wit típus színét több projekthez

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

Paraméterek

projectNames: string[]

Válaszok

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

getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)

Szerezze be a munkaelem-típus mezőinek listáját részletes hivatkozásokkal.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

type: string

Munkaelem típusa.

expand: WorkItemTypeFieldsExpandLevel

Bontsa ki az API-válasz szintjét. Tulajdonságok: az allowedvalues, az alapértelmezett érték, az isRequired stb. belefoglalása a válasz részeként; Nincs: a tulajdonságok kihagyása.

Válaszok

Promise<WorkItemTypeFieldWithReferences[]>

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

Szerezzen be egy mezőt egy munkaelem-típushoz részletes hivatkozásokkal.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

type: string

Munkaelem típusa.

field: string

expand: WorkItemTypeFieldsExpandLevel

Bontsa ki az API-válasz szintjét. Tulajdonságok: az allowedvalues, az alapértelmezett érték, az isRequired stb. belefoglalása a válasz részeként; Nincs: a tulajdonságok kihagyása.

Válaszok

Promise<WorkItemTypeFieldWithReferences>

getWorkItemTypes(string)

A munkaelemtípusok listáját adja vissza

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

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<WorkItemType[]>

getWorkItemTypeStates(string, string)

Egy munkaelemtípus állapotnevét és színét adja vissza.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

type: string

Az állam neve

Válaszok

Promise<WorkItemStateColor[]>

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

Lekéri a lekérdezés eredményét a lekérdezés azonosítója alapján.

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

Paraméterek

id: string

A lekérdezés azonosítója.

project: string

Projektazonosító vagy projektnév

team: string

Csapatazonosító vagy csapatnév

timePrecision: boolean

Használjunk-e időpontosságot vagy sem.

top: number

A visszaadandó eredmények maximális száma.

Válaszok

Promise<WorkItemQueryResult>

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

Lekéri a lekérdezés eredményeit a WIQL alapján.

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

Paraméterek

wiql: Wiql

A WIQL-t tartalmazó lekérdezés.

project: string

Projektazonosító vagy projektnév

team: string

Csapatazonosító vagy csapatnév

timePrecision: boolean

Használjunk-e időpontosságot vagy sem.

top: number

A visszaadandó eredmények maximális száma.

Válaszok

Promise<WorkItemQueryResult>

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

Lekérdezi az összetevő URI-jának adott listájához csatolt munkaelemeket.

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

Paraméterek

artifactUriQuery: ArtifactUriQuery

Meghatározza a munkaelemek lekérdezéséhez szükséges összetevő URI-k listáját.

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<ArtifactUriQueryResult>

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

Munkaelem-módosítások kötegének lekérése a törölt elemek belefoglalásának lehetőségével

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>

Paraméterek

project: string

Projektazonosító vagy projektnév

fields: string[]

A munkaelem-módosításokban visszaadandó mezők listája. Hagyja ki ezt a paramétert az összes jelentendő mező lekéréséhez.

types: string[]

Az eredmények adott munkaelemtípusokra való szűrésére szolgáló típusok listája. Hagyja ki ezt a paramétert az összes munkaelem-típus munkaelem-változatának lekéréséhez.

continuationToken: string

Megadja azt a vízjelet, amelyből a köteg elindul. Hagyja ki ezt a paramétert a módosítások első kötegének lekéréséhez.

startDateTime: Date

A módosítások kiindulópontjaként használandó dátum/idő esetén minden módosítás ezen dátum/időpont után történik. Nem használható együtt a "vízjel" paraméterrel.

includeIdentityRef: boolean

Identitásmezők karakterláncértéke helyett identitáshivatkozást ad vissza.

includeDeleted: boolean

Adja meg, hogy a törölt elemet vissza kell-e adni.

includeTagRef: boolean

Adja meg, hogy a címkeobjektumokat vissza kell-e adni a System.Tags mezőhöz.

includeLatestOnly: boolean

Csak a munkaelemek legújabb változatait adja vissza, kihagyva az összes előzménymódosítást

expand: ReportingRevisionsExpand

A munkaelem-változatok összes mezőjének visszaadása, beleértve az alapértelmezés szerint nem visszaadott hosszú szövegmezőket is

includeDiscussionChangesOnly: boolean

Csak a munkaelemek azon változatait adja vissza, ahol csak az előzménymező módosult

maxPageSize: number

A kötegben visszaadandó eredmények maximális száma

Válaszok

Promise<ReportingWorkItemRevisionsBatch>

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

Szerezzen be egy köteg munkaelem-módosítást. Ez a kérés akkor használható, ha a mezők listája elég nagy ahhoz, hogy az URL-címet a hosszkorláton túl futtathassa.

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

Paraméterek

filter: ReportingWorkItemRevisionsFilter

Kérelembeállításokat tartalmazó objektum: mezőszűrő, típusszűrő, identitásformátum

project: string

Projektazonosító vagy projektnév

continuationToken: string

Megadja azt a vízjelet, amelyből a köteg elindul. Hagyja ki ezt a paramétert a módosítások első kötegének lekéréséhez.

startDateTime: Date

A módosítások kiindulópontjaként használandó dátum/idő esetén minden módosítás ezen dátum/időpont után történik. Nem használható együtt a "vízjel" paraméterrel.

expand: ReportingRevisionsExpand

Válaszok

Promise<ReportingWorkItemRevisionsBatch>

replaceTemplate(WorkItemTemplate, string, string, string)

Sablon tartalmának cseréje

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

Paraméterek

templateContent: WorkItemTemplate

A sablon tartalma a következőre cserélhető

project: string

Projektazonosító vagy projektnév

team: string

Csapatazonosító vagy csapatnév

templateId: string

Sablon azonosítója

Válaszok

Promise<WorkItemTemplate>

restoreWorkItem(WorkItemDeleteUpdate, number, string)

Visszaállítja a törölt munkaelemet a Lomtárból.

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

Paraméterek

payload: WorkItemDeleteUpdate

Paylod utasításokkal az IsDeleted jelző hamis értékre való frissítésére

id: number

A visszaállítandó munkaelem azonosítója

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<WorkItemDelete>

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

Megkeresi az összes lekérdezést, amelyhez a felhasználó hozzáfér az aktuális projektben

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

Paraméterek

project: string

Projektazonosító vagy projektnév

filter: string

A lekérdezések szűréséhez használt szöveg.

top: number

A visszaadandó lekérdezések száma (az alapértelmezett érték 50, a maximális pedig 200).

expand: QueryExpand

includeDeleted: boolean

Törölt lekérdezések és mappák belefoglalása

Válaszok

Promise<QueryHierarchyItemsResult>

sendMail(SendMailBody, string)

RESTful metódus a kijelölt/lekérdezett munkaelemek e-mailjeinek küldésére.

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

Paraméterek

body: SendMailBody

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<void>

updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Meglévő besorolási csomópont frissítése.

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

Paraméterek

postedNode: WorkItemClassificationNode

Csomópont létrehozásához vagy frissítéséhez.

project: string

Projektazonosító vagy projektnév

structureGroup: TreeStructureGroup

Az osztályozási csomópont, terület vagy iteráció struktúracsoportja.

path: string

A besorolási csomópont elérési útja.

Válaszok

Promise<WorkItemClassificationNode>

updateField(UpdateWorkItemField, string, string)

Mező frissítése.

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

Paraméterek

payload: UpdateWorkItemField

A hasznos adatok a mező tulajdonságainak kívánt értékét tartalmazzák

fieldNameOrRefName: string

A frissítendő mező neve/hivatkozási neve

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<WorkItemField>

updateQuery(QueryHierarchyItem, string, string, boolean)

Lekérdezés vagy mappa frissítése. Ez lehetővé teszi a lekérdezések és mappák frissítését, átnevezését és áthelyezését.

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

Paraméterek

queryUpdate: QueryHierarchyItem

A frissítendő lekérdezés.

project: string

Projektazonosító vagy projektnév

query: string

A frissíteni kívánt lekérdezés azonosítója vagy elérési útja.

undeleteDescendants: boolean

Vonja vissza a mappa gyermekeinek törlését. Fontos megjegyezni, hogy ez nem hozza vissza a leszármazottakra korábban alkalmazott engedélymódosításokat.

Válaszok

Promise<QueryHierarchyItem>

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

Egyetlen munkaelemet frissít.

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

Paraméterek

document: JsonPatchDocument

A frissítést képviselő JSON-javítási dokumentum

id: number

A frissíteni kívánt munkaelem azonosítója

project: string

Projektazonosító vagy projektnév

validateOnly: boolean

Jelezze, hogy csak a munkaelem mentése nélkül szeretné-e érvényesíteni a módosításokat

bypassRules: boolean

A munkaelem-típusszabályok kényszerítésének mellőzése ezen a frissítésen

suppressNotifications: boolean

Ne küldjön értesítést erről a módosításról

expand: WorkItemExpand

A munkaelem-attribútumok paramétereinek kibontása. A lehetséges opciók a következők: { Nincs, Kapcsolatok, Mezők, Hivatkozások, Összes }.

Válaszok

Promise<WorkItem>

updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)

Munkaelem-típus hozzáadása/frissítése

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

Paraméterek

updateModel: WorkItemTypeTemplateUpdateModel

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<ProvisioningResult>

Visszacsatolás

Hasznos volt ez az oldal?

Megosztás:

WorkItemTrackingRestClient class

Konstruktorok

Tulajdonságok

Metódusok

Konstruktor adatai

WorkItemTrackingRestClient(IVssRestClientOptions)

Paraméterek

Tulajdonság adatai

RESOURCE_AREA_ID

Tulajdonság értéke

Metódus adatai

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

Paraméterek

Válaszok

createField(WorkItemField, string)

Paraméterek

Válaszok

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Paraméterek

Válaszok

createQuery(QueryHierarchyItem, string, string, boolean)

Paraméterek

Válaszok

createTemplate(WorkItemTemplate, string, string)

Paraméterek

Válaszok

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

Paraméterek

Válaszok

deleteClassificationNode(string, TreeStructureGroup, string, number)

Paraméterek

Válaszok

deleteField(string, string)

Paraméterek

Válaszok

deleteQuery(string, string)

Paraméterek

Válaszok

deleteTemplate(string, string, string)

Paraméterek

Válaszok

deleteWorkItem(number, string, boolean)

Paraméterek

Válaszok

destroyWorkItem(number, string)

Paraméterek

Válaszok

exportWorkItemTypeDefinition(string, string, boolean)

Paraméterek

Válaszok

getAccountMyWorkData(QueryOption)

Paraméterek

Válaszok

getAttachmentContent(string, string, string, boolean)

Paraméterek

Válaszok

getAttachmentZip(string, string, string, boolean)

Paraméterek

Válaszok

getClassificationNode(string, TreeStructureGroup, string, number)

Paraméterek

Válaszok

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

Paraméterek

Válaszok

getComment(number, number, string)

Paraméterek

Válaszok

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

Paraméterek

Válaszok

getDeletedWorkItem(number, string)

Paraméterek

Válaszok

getDeletedWorkItems(number[], string)

Paraméterek

Válaszok

getDeletedWorkItemShallowReferences(string)

Paraméterek