WorkItemTrackingRestClient class

Referencia

Csomag:: azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k felé irányuló kérések küldéséhez (származtatásából) kell használni

Extends: RestClientBase

Konstruktorok

WorkItemTrackingRestClient(IVssRestClientOptions)

Tulajdonságok

RESOURCE_AREA_ID

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 újat, vagy frissítsen egy meglévő besorolási csomópontot.
createQuery(QueryHierarchyItem, string, string, boolean)	Létrehoz egy lekérdezést, vagy áthelyez egy lekérdezést.
createTemplate(WorkItemTemplate, string, string)	Sablon létrehozása
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. Egy iktatott fájl törlésének törléséhez lásd: "Mező frissítése" API.
deleteQuery(string, string)	Lekérdezés vagy mappa törlése. Ez törli a törölt lekérdezés vagy mappa engedélymódosításait, valamint annak leszármazottait, ha az mappa. Fontos megjegyezni, hogy a törölt engedélymódosítások nem állíthatók helyre a lekérdezés vagy mappa törlésekor.
deleteTemplate(string, string, string)	A megadott azonosítóval rendelkező sablon törlése
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 megsemmisítés paraméter igaz értékre van állítva, végleg megsemmisíti a munkaelemet. FIGYELMEZTETÉS: Ha a megsemmisítés paraméter igaz értékre van állítva, a parancs által törölt munkaelemek NEM kerülnek a lomtárba, és a törlés után nem lehet visszaállítani/helyreállítani őket. Nem ajánlott ezt a paramétert használni. Ha igen, használja ezt a paramétert rendkívül körültekintően.
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)	Munkaelemtípus exportálása
getAccountMyWorkData(QueryOption)	CSAK BELSŐ: A SAJÁT MUNKAHELYI FIÓK LAP HASZNÁLJA. Ez a Művelet, a Kész, a Nyomon követés és a tevékenység munkaelemek adatait adja vissza.
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 projekthez tartozó csomópontazonosítók listájához. Ha az ids paraméter meg van adva, lekérheti az azonosítók besorolási csomópontjainak listáját. Ellenkező esetben gyökérbesorolási csomópontokat fog kapni ehhez a projekthez.
getComment(number, number, string)	Beolvas egy megjegyzést 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)	Törölt munkaelemet kér le 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 törölt munkaelemek azonosítóinak és URL-címeinek listáját.
getField(string, string)	Információt 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érszintű lekérdezéseket és a gyermekeiket
getQueriesBatch(QueryBatchGetRequest, string)	Lekéri a lekérdezések listáját azonosítók szerint (legfeljebb 1000)
getQuery(string, string, QueryExpand, number, boolean, boolean)	Lekéri az egyes lekérdezéseket és azok gyermekeit
getQueryResultCount(string, string, string, boolean, number)	Lekéri a lekérdezés eredményeit a lekérdezésazonosító alapján.
getRecentActivityData()	Lekéri a legutóbbi munkaelem-tevékenységeket
getRecentMentions()	CSAK BELSŐ: A SAJÁT MUNKAHELYI FIÓK LAP HASZNÁLJA.
getRelationType(string)	Lekéri a munkaelem relációs típusdefinícióját.
getRelationTypes()	Lekéri a munkaelem-relációs típusokat.
getReportingLinksByLinkType(string, string[], string[], string, Date)	Munkaelem-hivatkozások kötegének lekérése
getRevision(number, number, string, WorkItemExpand)	Egy teljes mértékben hidratált munkaelemet ad vissza a kért változathoz
getRevisions(number, string, number, number, WorkItemExpand)	A teljes mértékben hidratált munkaelem-változatok lapozott 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)	Sablon lekérve
getUpdate(number, number, string)	Egyetlen frissítést ad vissza egy munkaelemhez
getUpdates(number, string, number, number)	A munkaelem-változatok közötti eltéréseket adja vissza
getWorkArtifactLinkTypes()	Lekérheti a kimenő munkaelem-kapcsolattípusok nyomon követésére szolgáló munkaelemek 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()	Lekérheti az összes munkaelem ikonjának listáját.
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)	Az adott 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érdezése a munkaelem-azonosítók listájához (legfeljebb 200)
getWorkItemStateColors(string[])	CSAK BELSŐ: A saját fiókom munkatapasztalatához fogjuk használni. 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)	Munkaelem-típusdefiníciót ad vissza.
getWorkItemTypeCategories(string)	Szerezze be az összes munkaelemtípus-kategóriát.
getWorkItemTypeCategory(string, string)	Konkrét munkaelem-típuskategória lekérése név szerint.
getWorkItemTypeColorAndIcons(string[])	CSAK BELSŐ: Szín- és ikonszolgáltatókhoz használható. Több projekt szellemes típusszínének lekérése
getWorkItemTypeColors(string[])	CSAK BELSŐ: A fiókom munkatapasztalatához fogjuk használni. Több projekt szellemes típusszínének lekérése
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)	A munkaelem-típus mezőinek listájának lekérése részletes hivatkozásokkal.
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)	Munkaelem-típus mezőinek lekérése részletes hivatkozásokkal.
getWorkItemTypes(string)	A munkaelemtípusok listáját adja vissza
getWorkItemTypeStates(string, string)	A munkaelem-típus állapotneveit és színeit adja vissza.
queryById(string, string, string, boolean, number)	Lekéri a lekérdezés eredményeit a lekérdezésazonosító alapján.
queryByWiql(Wiql, string, string, boolean, number)	Lekéri a lekérdezés eredményeit a WIQL-nek köszönhetően.
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)	Lekérdezi az összetevők URI-jának adott listájához csatolt munkaelemeket.
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)	Munkaelem-változatok kötegének lekérése a törölt elemek beleszámításának lehetőségével
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)	Munkaelem-változatok kötegének lekérése. 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 futtassa.
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 olyan lekérdezést, amelyhez a felhasználó hozzáféréssel rendelkezik az aktuális projektben
sendMail(SendMailBody, string)	RESTful metódus a kijelölt/lekérdezett munkaelemek e-mailjeinek küldéséhez.
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 munkaelem Frissítések.
updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)	Munkaelemtí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ési típusa: Egyszerű vagy darabolt

areaPath: string

Célprojekt területútvonala

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 újat, 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

Létrehozandó vagy frissítendő csomópont.

project: string

Projektazonosító vagy projektnév

structureGroup: TreeStructureGroup

A besorolá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)

Létrehoz egy lekérdezést, 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 szülőazonosító vagy elérési út, amely alatt létre kívánja hozni a lekérdezést.

validateWiqlOnly: boolean

Ha csak anélkül szeretné ellenőrizni a WIQL-lekérdezést, hogy ténylegesen létrehozna egyet, állítsa true (igaz) értékre. Az alapértelmezett érték a false (hamis).

Válaszok

Promise<QueryHierarchyItem>

createTemplate(WorkItemTemplate, string, string)

Sablon létrehozása

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

Csoportazonosító vagy csoportné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 jelölő JSON-javítás dokumentum

project: string

Projektazonosító vagy projektnév

type: string

A létrehozandó munkaelem típusa

validateOnly: boolean

Jelezze, hogy csak a munkaelem mentése nélkül szeretné-e ellenőrizni a módosításokat

bypassRules: boolean

Ne kényszerítse ki a munkaelem-típusra vonatkozó szabályokat ezen a frissítésen

suppressNotifications: boolean

Ne aktiválja a módosítással kapcsolatos értesítéseket

expand: WorkItemExpand

A munkaelem-attribútumok kibontási paraméterei. A lehetséges lehetőségek a következők: { Nincs, Kapcsolatok, Mezők, Hivatkozások, Mind }.

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

A besorolási csomópont, terület vagy iteráció struktúracsoportja.

path: string

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

reclassifyId: number

Az átsorolás célbesorolási csomópontjának azonosítója.

Válaszok

Promise<void>

deleteField(string, string)

Törli a mezőt. Egy iktatott fájl törlésének törléséhez lásd: "Mező frissítése" API.

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

Paraméterek

fieldNameOrRefName: string

Mező egyszerű neve vagy hivatkozásneve

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<void>

deleteQuery(string, string)

Lekérdezés vagy mappa törlése. Ez törli a törölt lekérdezés vagy mappa engedélymódosításait, valamint annak leszármazottait, ha az mappa. Fontos megjegyezni, hogy a törölt engedélymódosítások nem állíthatók helyre a lekérdezés vagy mappa törlésekor.

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)

A megadott azonosítóval rendelkező sablon törlése

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

Paraméterek

project: string

Projektazonosító vagy projektnév

team: string

Csoportazonosító vagy csoportnév

templateId: string

Sablonazonosító

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 megsemmisítés paraméter igaz értékre van állítva, végleg megsemmisíti a munkaelemet. FIGYELMEZTETÉS: Ha a megsemmisítés paraméter igaz értékre van állítva, a parancs által törölt munkaelemek NEM kerülnek a lomtárba, és a törlés után nem lehet visszaállítani/helyreállítani őket. Nem ajánlott ezt a paramétert használni. Ha igen, használja ezt a paramétert rendkívül körültekintően.

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. Vegye figyelembe, hogy a megsemmisítés művelet ÁLLANDÓ, é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íteni kívánt munkaelem azonosítója

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<void>

exportWorkItemTypeDefinition(string, string, boolean)

Munkaelemtí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 SAJÁT MUNKAHELYI FIÓK LAP HASZNÁLJA. Ez a Művelet, a Kész, a Nyomon követés és a tevékenység munkaelemek adatait adja vissza.

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 a 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 a 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

A besorolási csomópont, terület vagy iteráció struktúracsoportja.

path: string

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

depth: number

A lehívandó 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 projekthez tartozó csomópontazonosítók listájához. Ha az ids paraméter meg van adva, lekérheti az azonosítók besorolási csomópontjainak listáját. Ellenkező esetben gyökérbesorolási csomópontokat fog kapni 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ója. Ha gyökércsomópontokra van szüksége, nem szükséges.

depth: number

A lehívandó gyermekek mélysége.

errorPolicy: ClassificationNodesErrorPolicy

Jelző egyes csomópontok beolvasása során előforduló hibák kezelésére. Lehetséges lehetőségek: Fail (Sikertelen) és Omit (Kihagyás).

Válaszok

Promise<WorkItemClassificationNode[]>

getComment(number, number, string)

Beolvas egy megjegyzést 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

Az a változat, amelyhez a megjegyzést be 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

Korrektúra, amelyből a megjegyzések beolvashatók (alapértelmezés szerint 1)

top: number

A visszaküldött megjegyzések száma (alapértelmezés szerint 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)

Törölt munkaelemet kér le a Lomtárból.

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

Paraméterek

id: number

A visszaadni kívánt 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 visszaküldött 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 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ót kap egy adott mezőről.

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

Paraméterek

fieldNameOrRefName: string

Mező egyszerű neve vagy hivatkozásneve

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 mellékmezőket is felvehet, máskülönben kizárhatja őket. Ha nincs engedélyezve a paraméter funkciójelölője, a bővítménymezők mindig megjelennek.

Válaszok

Promise<WorkItemField[]>

getQueries(string, QueryExpand, number, boolean)

Lekéri a gyökérszintű lekérdezéseket és a gyermekeiket

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

Paraméterek

project: string

Projektazonosító vagy projektnév

expand: QueryExpand

Adja meg a lekérdezési sztringet (wiql), a záradékokat, a lekérdezés eredményoszlopait és a rendezési beállításokat az eredményekben.

depth: number

A lekérdezések mappájában ilyen mélységben adja vissza a gyermek lekérdezéseket és mappákat.

includeDeleted: boolean

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

Válaszok

Promise<QueryHierarchyItem[]>

getQueriesBatch(QueryBatchGetRequest, string)

Lekéri a lekérdezések listáját azonosítók szerint (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éri az egyes lekérdezéseket és azok 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

Adja meg a lekérdezési sztringet (wiql), a záradékokat, a lekérdezés eredményoszlopait és a rendezési beállításokat az eredményekben.

depth: number

A lekérdezések mappájában ilyen mélységben adja vissza a gyermek lekérdezéseket és mappákat.

includeDeleted: boolean

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

useIsoDateFormat: boolean

A DateTime lekérdezési záradékok ISO 8601-kompatibilis formátumban lesznek formázva

Válaszok

Promise<QueryHierarchyItem>

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

Lekéri a lekérdezés eredményeit a lekérdezésazonosító 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

Csoportazonosító vagy csoportnév

timePrecision: boolean

Az idő pontosságának használata.

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 SAJÁT MUNKAHELYI FIÓK LAP HASZNÁLJA.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Válaszok

Promise<AccountRecentMentionWorkItemModel[]>

getRelationType(string)

Lekéri a munkaelem relációs típusdefinícióját.

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

Paraméterek

relation: string

A kapcsolat neve

Válaszok

Promise<WorkItemRelationType>

getRelationTypes()

Lekéri a munkaelem-relációs típusokat.

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[]

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

types: string[]

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

continuationToken: string

Megadja a folytatásToken paramétert a köteg indításához. Hagyja ki ezt a paramétert a hivatkozások első kötegének lekéréséhez.

startDateTime: Date

Hivatkozásmódosítások kiindulási pontjaként használandó dátum/idő. Csak az adott dátum/idő után történt hivatkozásmódosítások lesznek visszaadva. A "vízjel" paraméterrel együtt nem használható.

Válaszok

Promise<ReportingWorkItemLinksBatch>

getRevision(number, number, string, WorkItemExpand)

Egy teljes mértékben 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 teljes mértékben hidratált munkaelem-változatok lapozott 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

A lehívandó 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

Csoportazonosító vagy csoportnév

templateId: string

Sablonazonosító

Válaszok

Promise<WorkItemTemplate>

getTemplates(string, string, string)

Sablon lekérve

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

Paraméterek

project: string

Projektazonosító vagy projektnév

team: string

Csoportazonosító vagy csoportnév

workitemtypename: string

Nem kötelező, Ha megadott, a megadott munkaelemtípushoz tartozó sablonokat ad vissza.

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 munkaelem-változatok közötti eltéréseket 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()

Lekérheti a kimenő munkaelem-kapcsolattípusok nyomon követésére szolgáló munkaelemek 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

Utc dátum és idő sztringje

expand: WorkItemExpand

A munkaelem-attribútumok kibontási paraméterei. A lehetséges lehetőségek a következők: { Nincs, Kapcsolatok, Mezők, Hivatkozások, Mind }.

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 hatjegyű hexadecimális színe

v: number

Az ikon verziója (csak a gyorsítótár érvénytelenítéséhez használatos)

Válaszok

Promise<WorkItemIcon>

getWorkItemIcons()

Lekérheti az összes munkaelem ikonjának listáját.

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 hatjegyű hexadecimális színe

v: number

Az ikon verziója (csak a gyorsítótár érvénytelenítéséhez használatos)

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 hatjegyű hexadecimális színe

v: number

Az ikon verziója (csak a gyorsítótár érvénytelenítéséhez használatos)

Válaszok

Promise<any>

getWorkItemNextStatesOnCheckinAction(number[], string)

Az adott 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 műveletek. 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

Utc dátum és idő sztringje

expand: WorkItemExpand

A munkaelem-attribútumok kibontási paraméterei. A lehetséges lehetőségek a következők: { Nincs, Kapcsolatok, Mezők, Hivatkozások, Mind }.

errorPolicy: WorkItemErrorPolicy

A hibaszabályzat tömeges lekérésére vonatkozó kérelem hibaszabályzatának vezérlésére szolgáló jelző. Lehetséges lehetőségek: {Fail, Omit}.

Válaszok

Promise<WorkItem[]>

getWorkItemsBatch(WorkItemBatchGetRequest, string)

Munkaelemek lekérdezé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 saját fiókom munkatapasztalatához fogjuk használni. 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

Házon kívül – UTC dátum idő sztringje

expand: WorkItemExpand

A munkaelem-attribútumok kibontási paraméterei. A lehetséges lehetőségek a következők: { Nincs, Kapcsolatok, Mezők, Hivatkozások, Mind }.

Válaszok

Promise<WorkItem>

getWorkItemType(string, string)

Munkaelem-típusdefiní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)

Szerezze be az összes munkaelemtípus-kategóriát.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<WorkItemTypeCategory[]>

getWorkItemTypeCategory(string, string)

Konkrét munkaelem-típuskategó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álható. Több projekt szellemes típusszínének lekérése

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 fogjuk használni. Több projekt szellemes típusszínének lekérése

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

Paraméterek

projectNames: string[]

Válaszok

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

getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)

A munkaelem-típus mezőinek listájának lekérése 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 engedélyezett értékek, az alapértelmezett érték, az isRequired stb. belefoglalása a válasz részeként; Nincs: kihagyhatja ezeket a tulajdonságokat.

Válaszok

Promise<WorkItemTypeFieldWithReferences[]>

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

Munkaelem-típus mezőinek lekérése 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

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)

A munkaelem-típus állapotneveit és színeit adja vissza.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

type: string

Az állapot neve

Válaszok

Promise<WorkItemStateColor[]>

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

Lekéri a lekérdezés eredményeit a lekérdezésazonosító 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

Csoportazonosító vagy csoportnév

timePrecision: boolean

Az idő pontosságának használata.

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-nek köszönhetően.

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

Csoportazonosító vagy csoportnév

timePrecision: boolean

Az idő pontosságának használata.

top: number

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

Válaszok

Promise<WorkItemQueryResult>

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

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

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

Paraméterek

artifactUriQuery: ArtifactUriQuery

Meghatározza az összetevők URI-jának listáját a munkaelemek lekérdezéséhez.

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-változatok kötegének lekérése a törölt elemek beleszámítá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-változatokban visszaadandó mezők listája. Kihagyja ezt a paramétert az összes jelentésképes mező lekéréséhez.

types: string[]

Az eredmények adott munkaelem-típusokra való szűréséhez használható típusok listája. Ezt a paramétert kihagyva lekérheti az összes munkaelemtípus munkaelem-változatait.

continuationToken: string

Megadja a köteg indításához a vízjelet. Kihagyja ezt a paramétert a korrektúra első kötegének lekéréséhez.

startDateTime: Date

A korrektúrák kiindulási pontjaként használandó dátum/idő, minden korrektúra ezt a dátumot/időpontot követően következik be. A "vízjel" paraméterrel együtt nem használható.

includeIdentityRef: boolean

Identitásmezők sztringé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 System.Tags mezőhöz vissza kell-e adni a címkeobjektumokat.

includeLatestOnly: boolean

Csak a munkaelemek legújabb változatait adja vissza, kihagyva az összes előzményváltozatot

expand: ReportingRevisionsExpand

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

includeDiscussionChangesOnly: boolean

Csak a munkaelemek korrektúráit adja vissza, ahol csak az előzménymező módosult

maxPageSize: number

Az ebben a kötegben visszaadandó eredmények maximális száma

Válaszok

Promise<ReportingWorkItemRevisionsBatch>

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

Munkaelem-változatok kötegének lekérése. 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 futtassa.

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 a köteg indításához a vízjelet. Kihagyja ezt a paramétert a korrektúra első kötegének lekéréséhez.

startDateTime: Date

A korrektúrák kiindulási pontjaként használandó dátum/idő, minden korrektúra ezt a dátumot/időpontot követően következik be. A "vízjel" paraméterrel együtt nem használható.

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 lecserélendő sablon tartalma

project: string

Projektazonosító vagy projektnév

team: string

Csoportazonosító vagy csoportnév

templateId: string

Sablonazonosító

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

A Paylod az IsDeleted jelző false (hamis) értékre való frissítésére vonatkozó utasításokat tartalmaz

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 olyan lekérdezést, amelyhez a felhasználó hozzáféréssel rendelkezik 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álható szöveg.

top: number

A visszaadandó lekérdezések száma (az alapértelmezett érték 50, a maximális érték 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éhez.

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

Létrehozandó vagy frissítendő csomópont.

project: string

Projektazonosító vagy projektnév

structureGroup: TreeStructureGroup

A besorolá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 adat a mező tulajdonságainak kívánt értékét tartalmazza

fieldNameOrRefName: string

A frissíteni kívánt mező neve/hivatkozása

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íteni kívánt 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

Törölje a mappa gyermekeinek törlését. Fontos megjegyezni, hogy ez nem fogja visszahozni a leszármazottakra korábban alkalmazott engedélymódosításokat.

Válaszok

Promise<QueryHierarchyItem>

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

egyetlen munkaelem Frissítések.

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 jelképező JSON-javítás 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 ellenőrizni a módosításokat

bypassRules: boolean

Ne kényszerítse ki a munkaelem-típusra vonatkozó szabályokat ezen a frissítésen

suppressNotifications: boolean

Ne aktiválja a módosítással kapcsolatos értesítéseket

expand: WorkItemExpand

A munkaelem-attribútumok kibontási paraméterei. A lehetséges lehetőségek a következők: { Nincs, Kapcsolatok, Mezők, Hivatkozások, Mind }.

Válaszok

Promise<WorkItem>

updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)

Munkaelemtí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>

Megosztás a következőn keresztül:

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