WorkItemTrackingRestClient class

套件:: azure-devops-extension-api

應該用來對 VSS REST API 提出要求的基類（衍生自）

Extends: RestClientBase

建構函式

WorkItemTrackingRestClient(IVssRestClientOptions)

屬性

方法

createAttachment(any, string, string, string, string)	上傳附件。
createField(WorkItemField, string)	建立新欄位。
createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	建立新的分類節點或更新現有的分類節點。
createQuery(QueryHierarchyItem, string, string, boolean)	建立查詢，或移動查詢。
createTemplate(WorkItemTemplate, string, string)	建立範本
createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)	建立單一工作專案。
deleteClassificationNode(string, TreeStructureGroup, string, number)	刪除現有的分類節點。
deleteField(string, string)	刪除欄位。若要取消刪除欄位，請參閱「更新欄位」API。
deleteQuery(string, string)	刪除查詢或資料夾。這會刪除已刪除查詢或資料夾及其任何子代（如果它是資料夾）的任何權限變更。請務必注意，取消刪除查詢或資料夾後無法恢復已刪除的權限變更。
deleteTemplate(string, string, string)	刪除具有指定 ID 的範本
deleteWorkItem(number, string, boolean)	刪除指定的工作專案，並將它傳送至資源回收筒，以便在需要時還原回來。或者，如果 destroy 參數已設定為 true，它會永久終結工作專案。警告：如果 destroy 參數設定為 true，則此命令刪除的工作專案將不會移至資源回收筒，而且刪除後無法還原/復原它們。建議不要使用此參數。如果這樣做，請格外小心使用此參數。
destroyWorkItem(number, string)	從資源回收筒永久終結指定的工作專案。此操作無法復原。
exportWorkItemTypeDefinition(string, string, boolean)	匯出工作專案類型
getAccountMyWorkData(QueryOption)	僅限內部：由帳戶「我的工作」頁面使用。這會傳回 [執行中]、[完成]、[遵循] 和活動工作專案詳細資料。
getAttachmentContent(string, string, string, boolean)	下載附件。
getAttachmentZip(string, string, string, boolean)	下載附件。
getClassificationNode(string, TreeStructureGroup, string, number)	取得指定節點路徑的分類節點。
getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)	取得給定專案的給定節點 ID 清單的根分類節點或分類節點清單。如果提供 ids 參數，您將獲得這些 id 的分類節點清單。否則，您將獲得此專案的根分類節點。
getComment(number, number, string)	取得指定修訂中工作專案的註解。
getComments(number, string, number, number, CommentSortOrder)	從指定的修訂取得工作專案的指定批注數目。
getDeletedWorkItem(number, string)	從資源回收筒取得已刪除的工作專案。
getDeletedWorkItems(number[], string)	從資源回收筒取得工作專案，其識別碼已在參數中指定
getDeletedWorkItemShallowReferences(string)	取得資源回收筒中已刪除工作專案的標識碼和 URL 清單。
getField(string, string)	取得特定欄位的資訊。
getFields(string, GetFieldsExpand)	傳回所有欄位的資訊。專案 ID/名稱參數是選擇性的。
getQueries(string, QueryExpand, number, boolean)	取得根查詢及其子系
getQueriesBatch(QueryBatchGetRequest, string)	依 ID 取得查詢清單（最多 1000 個）
getQuery(string, string, QueryExpand, number, boolean, boolean)	擷取個別查詢及其子系
getQueryResultCount(string, string, string, boolean, number)	取得指定的查詢結果。
getRecentActivityData()	取得最近的工作專案活動
getRecentMentions()	僅限內部：由帳戶「我的工作」頁面使用。
getRelationType(string)	取得工作專案關聯性類型定義。
getRelationTypes()	取得工作專案關聯性類型。
getReportingLinksByLinkType(string, string[], string[], string, Date)	取得一批工作專案連結
getRevision(number, number, string, WorkItemExpand)	傳回所要求修訂的完整水合工作專案
getRevisions(number, string, number, number, WorkItemExpand)	傳回完全凍結工作專案修訂的清單，分頁。
getRootNodes(string, number)	取得專案下的根分類節點。
getTemplate(string, string, string)	取得具有指定識別碼的範本
getTemplates(string, string, string)	取得範本
getUpdate(number, number, string)	傳回工作專案的單一更新
getUpdates(number, string, number, number)	傳回工作專案修訂之間的差異
getWorkArtifactLinkTypes()	取得工作專案追蹤輸出成品連結類型的清單。
getWorkItem(number, string, string[], Date, WorkItemExpand)	傳回單一工作專案。
getWorkItemIconJson(string, string, number)	取得工作專案圖示，提供易記名稱和圖示色彩。
getWorkItemIcons()	取得所有工作專案圖示的清單。
getWorkItemIconSvg(string, string, number)	取得工作專案圖示，提供易記名稱和圖示色彩。
getWorkItemIconXaml(string, string, number)	取得工作專案圖示，提供易記名稱和圖示色彩。
getWorkItemNextStatesOnCheckinAction(number[], string)	傳回指定工作專案識別碼的下一個狀態。
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)	傳回工作專案清單（最多 200）
getWorkItemsBatch(WorkItemBatchGetRequest, string)	取得工作專案識別碼清單的工作專案（最多 200）
getWorkItemStateColors(string[])	僅限內部：它將用於我的帳戶工作體驗。取得多個專案的工作專案類型狀態色彩
getWorkItemTemplate(string, string, string, Date, WorkItemExpand)	從範本傳回單一工作專案。
getWorkItemType(string, string)	傳回工作專案類型定義。
getWorkItemTypeCategories(string)	取得所有工作專案類型類別。
getWorkItemTypeCategory(string, string)	依名稱取得特定工作專案類型類別。
getWorkItemTypeColorAndIcons(string[])	僅限內部：它用於顏色和圖標提供者。取得多個專案的機智類型顏色
getWorkItemTypeColors(string[])	僅限內部：它將用於我的帳戶工作體驗。取得多個專案的機智類型顏色
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)	取得工作專案類型的欄位清單，其中包含詳細參考。
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)	取得具有詳細參考的工作專案類型的欄位。
getWorkItemTypes(string)	傳回工作專案類型的清單
getWorkItemTypeStates(string, string)	傳回工作專案類型的狀態名稱和色彩。
queryById(string, string, string, boolean, number)	取得指定的查詢結果。
queryByWiql(Wiql, string, string, boolean, number)	取得指定其 WIQL 的查詢結果。
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)	查詢連結至指定成品 URI 清單的工作專案。
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)	取得一批工作專案修訂，並可選擇包含已刪除的專案
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)	取得一批工作專案修訂。如果您的欄位清單足夠大，可能會超過長度限制執行 URL，則可以使用此要求。
replaceTemplate(WorkItemTemplate, string, string, string)	取代範本內容
restoreWorkItem(WorkItemDeleteUpdate, number, string)	從資源回收筒還原已刪除的工作專案。
searchQueries(string, string, number, QueryExpand, boolean)	搜尋使用者在目前專案中有權存取的所有查詢
sendMail(SendMailBody, string)	RESTful 方法來傳送所選/查詢工作項目的郵件。
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	更新現有的分類節點。
updateField(UpdateWorkItemField, string, string)	更新欄位。
updateQuery(QueryHierarchyItem, string, string, boolean)	更新查詢或資料夾。這可讓您更新、重新命名和移動查詢和資料夾。
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)	更新單一工作專案。
updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)	新增/更新工作專案類型

建構函式詳細資料

WorkItemTrackingRestClient(IVssRestClientOptions)

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

參數

options: IVssRestClientOptions

屬性詳細資料

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

屬性值

string

方法詳細資料

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

上傳附件。

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

參數

content: any

要上傳的內容

project: string

項目識別碼或項目名稱

fileName: string

檔案名稱

uploadType: string

附件上傳類型：簡單或分塊

areaPath: string

目標專案區域路徑

傳回

Promise<AttachmentReference>

createField(WorkItemField, string)

建立新欄位。

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

參數

workItemField: WorkItemField

新欄位定義

project: string

項目識別碼或項目名稱

傳回

Promise<WorkItemField>

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

建立新的分類節點或更新現有的分類節點。

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

參數

postedNode: WorkItemClassificationNode

要建立或更新的節點。

project: string

項目識別碼或項目名稱

structureGroup: TreeStructureGroup

分類節點、區域或迭代的結構群組。

path: string

分類節點的路徑。

傳回

Promise<WorkItemClassificationNode>

createQuery(QueryHierarchyItem, string, string, boolean)

建立查詢，或移動查詢。

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

參數

postedQuery: QueryHierarchyItem

要建立的查詢。

project: string

項目識別碼或項目名稱

query: string

要在其下建立查詢的父 ID 或路徑。

validateWiqlOnly: boolean

如果您只想驗證 WIQL 查詢而不實際建立 WIQL 查詢，請將它設定為 true。預設值為 false。

傳回

Promise<QueryHierarchyItem>

createTemplate(WorkItemTemplate, string, string)

建立範本

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

參數

template: WorkItemTemplate

範本內容

project: string

項目識別碼或項目名稱

team: string

團隊 ID 或團隊名稱

傳回

Promise<WorkItemTemplate>

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

建立單一工作專案。

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

參數

document: JsonPatchDocument

代表工作專案的 JSON 修補程式文件

project: string

項目識別碼或項目名稱

type: string

要建立之工作專案的工作專案類型

validateOnly: boolean

指出您是否只想驗證變更而不儲存工作專案

bypassRules: boolean

請勿在此更新上強制執行工作專案類型規則

suppressNotifications: boolean

請勿針對此變更引發任何通知

expand: WorkItemExpand

工作專案屬性的展開參數。可能的選項包括 { None、Relations、Fields、Links、All }。

傳回

Promise<WorkItem>

deleteClassificationNode(string, TreeStructureGroup, string, number)

刪除現有的分類節點。

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

參數

project: string

項目識別碼或項目名稱

structureGroup: TreeStructureGroup

分類節點、區域或迭代的結構群組。

path: string

分類節點的路徑。

reclassifyId: number

用於重新分類的目標分類節點的 ID。

傳回

Promise<void>

deleteField(string, string)

刪除欄位。若要取消刪除欄位，請參閱「更新欄位」API。

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

參數

fieldNameOrRefName: string

欄位簡式名稱或參照名稱

project: string

項目識別碼或項目名稱

傳回

Promise<void>

deleteQuery(string, string)

刪除查詢或資料夾。這會刪除已刪除查詢或資料夾及其任何子代（如果它是資料夾）的任何權限變更。請務必注意，取消刪除查詢或資料夾後無法恢復已刪除的權限變更。

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

參數

project: string

項目識別碼或項目名稱

query: string

要刪除的查詢或資料夾的識別碼或路徑。

傳回

Promise<void>

deleteTemplate(string, string, string)

刪除具有指定 ID 的範本

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

參數

project: string

項目識別碼或項目名稱

team: string

團隊 ID 或團隊名稱

templateId: string

範本識別碼

傳回

Promise<void>

deleteWorkItem(number, string, boolean)

刪除指定的工作專案，並將它傳送至資源回收筒，以便在需要時還原回來。或者，如果 destroy 參數已設定為 true，它會永久終結工作專案。警告：如果 destroy 參數設定為 true，則此命令刪除的工作專案將不會移至資源回收筒，而且刪除後無法還原/復原它們。建議不要使用此參數。如果這樣做，請格外小心使用此參數。

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

參數

id: number

要刪除的工作專案識別碼

project: string

項目識別碼或項目名稱

destroy: boolean

選擇性參數，如果設為 true，則會永久刪除工作專案。請注意：銷毀動作是永久性的，無法撤消。

傳回

Promise<WorkItemDelete>

destroyWorkItem(number, string)

從資源回收筒永久終結指定的工作專案。此操作無法復原。

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

參數

id: number

要永久終結之工作專案的識別碼

project: string

項目識別碼或項目名稱

傳回

Promise<void>

exportWorkItemTypeDefinition(string, string, boolean)

匯出工作專案類型

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

參數

project: string

項目識別碼或項目名稱

type: string

exportGlobalLists: boolean

傳回

Promise<WorkItemTypeTemplate>

getAccountMyWorkData(QueryOption)

僅限內部：由帳戶「我的工作」頁面使用。這會傳回 [執行中]、[完成]、[遵循] 和活動工作專案詳細資料。

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

參數

queryOption: QueryOption

傳回

Promise<AccountMyWorkResult>

getAttachmentContent(string, string, string, boolean)

下載附件。

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

參數

id: string

附件 ID

project: string

項目識別碼或項目名稱

fileName: string

檔案名稱

download: boolean

如果設定為 <c>true</c> ，則一律下載附件

傳回

Promise<ArrayBuffer>

getAttachmentZip(string, string, string, boolean)

下載附件。

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

參數

id: string

附件 ID

project: string

項目識別碼或項目名稱

fileName: string

檔案名稱

download: boolean

如果設定為 <c>true</c> ，則一律下載附件

傳回

Promise<ArrayBuffer>

getClassificationNode(string, TreeStructureGroup, string, number)

取得指定節點路徑的分類節點。

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

參數

project: string

項目識別碼或項目名稱

structureGroup: TreeStructureGroup

分類節點、區域或迭代的結構群組。

path: string

分類節點的路徑。

depth: number

要取孩子的深度。

傳回

Promise<WorkItemClassificationNode>

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

取得給定專案的給定節點 ID 清單的根分類節點或分類節點清單。如果提供 ids 參數，您將獲得這些 id 的分類節點清單。否則，您將獲得此專案的根分類節點。

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

參數

project: string

項目識別碼或項目名稱

ids: number[]

逗號分隔的整數分類節點 ids。如果您想要根節點，則不需要。

depth: number

要取孩子的深度。

errorPolicy: ClassificationNodesErrorPolicy

Flag 以處理取得某些節點時的錯誤。可能的選項是 [失敗] 和 [省略]。

傳回

Promise<WorkItemClassificationNode[]>

getComment(number, number, string)

取得指定修訂中工作專案的註解。

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

參數

id: number

工作項目識別碼

revision: number

需要提取註釋的修訂

project: string

項目識別碼或項目名稱

傳回

Promise<WorkItemComment>

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

從指定的修訂取得工作專案的指定批注數目。

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

參數

id: number

工作項目識別碼

project: string

項目識別碼或項目名稱

fromRevision: number

要從中提取註解的修訂（預設值為 1）

top: number

要傳回的註解數（預設值為 200）

order: CommentSortOrder

依修訂識別碼遞增或遞減（預設為遞增）

傳回

Promise<WorkItemComments>

getDeletedWorkItem(number, string)

從資源回收筒取得已刪除的工作專案。

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

參數

id: number

要傳回的工作專案識別碼

project: string

項目識別碼或項目名稱

傳回

Promise<WorkItemDelete>

getDeletedWorkItems(number[], string)

從資源回收筒取得工作專案，其識別碼已在參數中指定

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

參數

ids: number[]

要傳回之已刪除工作專案識別碼的逗點分隔清單

project: string

項目識別碼或項目名稱

傳回

Promise<WorkItemDeleteReference[]>

getDeletedWorkItemShallowReferences(string)

取得資源回收筒中已刪除工作專案的標識碼和 URL 清單。

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

參數

project: string

項目識別碼或項目名稱

傳回

Promise<WorkItemDeleteShallowReference[]>

getField(string, string)

取得特定欄位的資訊。

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

參數

fieldNameOrRefName: string

欄位簡式名稱或參照名稱

project: string

項目識別碼或項目名稱

傳回

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

傳回所有欄位的資訊。專案 ID/名稱參數是選擇性的。

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

參數

project: string

項目識別碼或項目名稱

expand: GetFieldsExpand

使用 ExtensionFields 來包含延伸欄位，否則會排除它們。除非啟用此參數的功能旗標，否則一律會包含延伸欄位。

傳回

Promise<WorkItemField[]>

getQueries(string, QueryExpand, number, boolean)

取得根查詢及其子系

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

參數

project: string

項目識別碼或項目名稱

expand: QueryExpand

在結果中包含查詢字串（wiql）、子句、查詢結果資料行和排序選項。

depth: number

在查詢資料夾中，將子查詢和資料夾傳回至此深度。

includeDeleted: boolean

包含已刪除的查詢和資料夾

傳回

Promise<QueryHierarchyItem[]>

getQueriesBatch(QueryBatchGetRequest, string)

依 ID 取得查詢清單（最多 1000 個）

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

參數

queryGetRequest: QueryBatchGetRequest

project: string

項目識別碼或項目名稱

傳回

Promise<QueryHierarchyItem[]>

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

擷取個別查詢及其子系

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

參數

project: string

項目識別碼或項目名稱

query: string

查詢的識別碼或路徑。

expand: QueryExpand

在結果中包含查詢字串（wiql）、子句、查詢結果資料行和排序選項。

depth: number

在查詢資料夾中，將子查詢和資料夾傳回至此深度。

includeDeleted: boolean

包含已刪除的查詢和資料夾

useIsoDateFormat: boolean

DateTime 查詢子句將使用 ISO 8601 相容格式進行格式化

傳回

Promise<QueryHierarchyItem>

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

取得指定的查詢結果。

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

參數

id: string

查詢識別碼。

project: string

項目識別碼或項目名稱

team: string

團隊 ID 或團隊名稱

timePrecision: boolean

是否使用時間精確度。

top: number

要傳回的結果數目上限。

傳回

Promise<number>

getRecentActivityData()

取得最近的工作專案活動

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

傳回

Promise<AccountRecentActivityWorkItemModel2[]>

getRecentMentions()

僅限內部：由帳戶「我的工作」頁面使用。

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

傳回

Promise<AccountRecentMentionWorkItemModel[]>

getRelationType(string)

取得工作專案關聯性類型定義。

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

參數

relation: string

關係名稱

傳回

Promise<WorkItemRelationType>

getRelationTypes()

取得工作專案關聯性類型。

function getRelationTypes(): Promise<WorkItemRelationType[]>

傳回

Promise<WorkItemRelationType[]>

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

取得一批工作專案連結

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

參數

project: string

項目識別碼或項目名稱

linkTypes: string[]

將結果篩選為特定連結類型的類型清單。省略此參數以取得所有連結類型的工作專案連結。

types: string[]

類型清單，可將結果篩選為特定工作專案類型。省略此參數以取得所有工作專案類型的工作專案連結。

continuationToken: string

指定要從中啟動批次的 continuationToken。省略此參數即可取得第一批連結。

startDateTime: Date

用作連結變更起點的日期/時間。只會傳回該日期/時間之後發生的連結變更。不能與“watermark”參數一起使用。

傳回

Promise<ReportingWorkItemLinksBatch>

getRevision(number, number, string, WorkItemExpand)

傳回所要求修訂的完整水合工作專案

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

參數

id: number

revisionNumber: number

project: string

項目識別碼或項目名稱

expand: WorkItemExpand

傳回

Promise<WorkItem>

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

傳回完全凍結工作專案修訂的清單，分頁。

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

參數

id: number

project: string

項目識別碼或項目名稱

top: number

skip: number

expand: WorkItemExpand

傳回

Promise<WorkItem[]>

getRootNodes(string, number)

取得專案下的根分類節點。

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

參數

project: string

項目識別碼或項目名稱

depth: number

要取孩子的深度。

傳回

Promise<WorkItemClassificationNode[]>

getTemplate(string, string, string)

取得具有指定識別碼的範本

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

參數

project: string

項目識別碼或項目名稱

team: string

團隊 ID 或團隊名稱

templateId: string

範本識別碼

傳回

Promise<WorkItemTemplate>

getTemplates(string, string, string)

取得範本

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

參數

project: string

項目識別碼或項目名稱

team: string

團隊 ID 或團隊名稱

workitemtypename: string

選擇性，指定時會傳回指定工作專案類型的範本。

傳回

Promise<WorkItemTemplateReference[]>

getUpdate(number, number, string)

傳回工作專案的單一更新

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

參數

id: number

updateNumber: number

project: string

項目識別碼或項目名稱

傳回

Promise<WorkItemUpdate>

getUpdates(number, string, number, number)

傳回工作專案修訂之間的差異

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

參數

id: number

project: string

項目識別碼或項目名稱

top: number

skip: number

傳回

Promise<WorkItemUpdate[]>

getWorkArtifactLinkTypes()

取得工作專案追蹤輸出成品連結類型的清單。

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

傳回

Promise<WorkArtifactLink[]>

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

傳回單一工作專案。

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

參數

id: number

工作專案識別碼

project: string

項目識別碼或項目名稱

fields: string[]

以逗號分隔的請求欄位清單

asOf: Date

AsOf UTC 日期時間字串

expand: WorkItemExpand

工作專案屬性的展開參數。可能的選項包括 { None、Relations、Fields、Links、All }。

傳回

Promise<WorkItem>

getWorkItemIconJson(string, string, number)

取得工作專案圖示，提供易記名稱和圖示色彩。

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

參數

icon: string

圖示的名稱

color: string

圖示的 6 位數十六進位顏色

v: number

圖示的版本（僅用於快取失效）

傳回

Promise<WorkItemIcon>

getWorkItemIcons()

取得所有工作專案圖示的清單。

function getWorkItemIcons(): Promise<WorkItemIcon[]>

傳回

Promise<WorkItemIcon[]>

getWorkItemIconSvg(string, string, number)

取得工作專案圖示，提供易記名稱和圖示色彩。

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

參數

icon: string

圖示的名稱

color: string

圖示的 6 位數十六進位顏色

v: number

圖示的版本（僅用於快取失效）

傳回

Promise<any>

getWorkItemIconXaml(string, string, number)

取得工作專案圖示，提供易記名稱和圖示色彩。

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

參數

icon: string

圖示的名稱

color: string

圖示的 6 位數十六進位顏色

v: number

圖示的版本（僅用於快取失效）

傳回

Promise<any>

getWorkItemNextStatesOnCheckinAction(number[], string)

傳回指定工作專案識別碼的下一個狀態。

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

參數

ids: number[]

工作專案識別碼清單

action: string

可能的行動。目前僅支援簽到

傳回

Promise<WorkItemNextStateOnTransition[]>

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

傳回工作專案清單（最多 200）

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

參數

ids: number[]

要求工作專案識別碼的逗號分隔清單。（最多允許 200 個 ID）。

project: string

項目識別碼或項目名稱

fields: string[]

以逗號分隔的請求欄位清單

asOf: Date

AsOf UTC 日期時間字串

expand: WorkItemExpand

工作專案屬性的展開參數。可能的選項包括 { None、Relations、Fields、Links、All }。

errorPolicy: WorkItemErrorPolicy

在大量取得工作專案要求中控制錯誤原則的旗標。可能的選項是 {Fail， Omit}。

傳回

Promise<WorkItem[]>

getWorkItemsBatch(WorkItemBatchGetRequest, string)

取得工作專案識別碼清單的工作專案（最多 200）

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

參數

workItemGetRequest: WorkItemBatchGetRequest

project: string

項目識別碼或項目名稱

傳回

Promise<WorkItem[]>

getWorkItemStateColors(string[])

僅限內部：它將用於我的帳戶工作體驗。取得多個專案的工作專案類型狀態色彩

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

參數

projectNames: string[]

傳回

Promise<ProjectWorkItemStateColors[]>

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

從範本傳回單一工作專案。

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

參數

project: string

項目識別碼或項目名稱

type: string

工作專案類型名稱

fields: string

以逗號分隔的請求欄位清單

asOf: Date

AsOf UTC 日期時間字串

expand: WorkItemExpand

工作專案屬性的展開參數。可能的選項包括 { None、Relations、Fields、Links、All }。

傳回

Promise<WorkItem>

getWorkItemType(string, string)

傳回工作專案類型定義。

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

參數

project: string

項目識別碼或項目名稱

type: string

工作專案類型名稱

傳回

Promise<WorkItemType>

getWorkItemTypeCategories(string)

取得所有工作專案類型類別。

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

參數

project: string

項目識別碼或項目名稱

傳回

Promise<WorkItemTypeCategory[]>

getWorkItemTypeCategory(string, string)

依名稱取得特定工作專案類型類別。

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

參數

project: string

項目識別碼或項目名稱

category: string

類別名稱

傳回

Promise<WorkItemTypeCategory>

getWorkItemTypeColorAndIcons(string[])

僅限內部：它用於顏色和圖標提供者。取得多個專案的機智類型顏色

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

參數

projectNames: string[]

傳回

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

getWorkItemTypeColors(string[])

僅限內部：它將用於我的帳戶工作體驗。取得多個專案的機智類型顏色

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

參數

projectNames: string[]

傳回

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

getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)

取得工作專案類型的欄位清單，其中包含詳細參考。

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

參數

project: string

項目識別碼或項目名稱

type: string

工作專案類型。

expand: WorkItemTypeFieldsExpandLevel

展開 API 回應的層級。屬性：將allowedvalues、預設值、isRequired等作為回應的一部分;None：略過這些屬性。

傳回

Promise<WorkItemTypeFieldWithReferences[]>

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

取得具有詳細參考的工作專案類型的欄位。

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

參數

project: string

項目識別碼或項目名稱

type: string

工作專案類型。

field: string

expand: WorkItemTypeFieldsExpandLevel

展開 API 回應的層級。屬性：將allowedvalues、預設值、isRequired等作為回應的一部分;None：略過這些屬性。

傳回

Promise<WorkItemTypeFieldWithReferences>

getWorkItemTypes(string)

傳回工作專案類型的清單

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

參數

project: string

項目識別碼或項目名稱

傳回

Promise<WorkItemType[]>

getWorkItemTypeStates(string, string)

傳回工作專案類型的狀態名稱和色彩。

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

參數

project: string

項目識別碼或項目名稱

type: string

狀態名稱

傳回

Promise<WorkItemStateColor[]>

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

取得指定的查詢結果。

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

參數

id: string

查詢識別碼。

project: string

項目識別碼或項目名稱

team: string

團隊 ID 或團隊名稱

timePrecision: boolean

是否使用時間精確度。

top: number

要傳回的結果數目上限。

傳回

Promise<WorkItemQueryResult>

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

取得指定其 WIQL 的查詢結果。

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

參數

wiql: Wiql

包含 WIQL 的查詢。

project: string

項目識別碼或項目名稱

team: string

團隊 ID 或團隊名稱

timePrecision: boolean

是否使用時間精確度。

top: number

要傳回的結果數目上限。

傳回

Promise<WorkItemQueryResult>

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

查詢連結至指定成品 URI 清單的工作專案。

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

參數

artifactUriQuery: ArtifactUriQuery

定義用於查詢工作專案的成品 URI 清單。

project: string

項目識別碼或項目名稱

傳回

Promise<ArtifactUriQueryResult>

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

取得一批工作專案修訂，並可選擇包含已刪除的專案

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>

參數

project: string

項目識別碼或項目名稱

fields: string[]

要在工作專案修訂中傳回的欄位清單。省略此參數以取得所有可報告的欄位。

types: string[]

類型清單，可將結果篩選為特定工作專案類型。省略此參數，以取得所有工作專案類型的工作專案修訂。

continuationToken: string

指定要從中開始批次的浮水印。省略此參數可取得第一批修訂。

startDateTime: Date

用作修訂起點的日期/時間，所有修訂都將在此日期/時間之後發生。不能與“watermark”參數一起使用。

includeIdentityRef: boolean

傳回身分參照，而不是身分欄位的字串值。

includeDeleted: boolean

指定是否應傳回已刪除的項目。

includeTagRef: boolean

指定是否應該針對 System.Tags 欄位傳回標籤物件。

includeLatestOnly: boolean

只傳回工作項目的最新修訂，略過所有歷程修訂

expand: ReportingRevisionsExpand

傳回工作專案修訂中的所有欄位，包括預設不會傳回的長文字欄位

includeDiscussionChangesOnly: boolean

只傳回工作專案的那些修訂，其中只有歷程記錄欄位已變更

maxPageSize: number

此批次中要傳回的結果數目上限

傳回

Promise<ReportingWorkItemRevisionsBatch>

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

取得一批工作專案修訂。如果您的欄位清單足夠大，可能會超過長度限制執行 URL，則可以使用此要求。

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

參數

filter: ReportingWorkItemRevisionsFilter

包含要求設定的物件：欄位篩選器、類型篩選器、身分格式

project: string

項目識別碼或項目名稱

continuationToken: string

指定要從中開始批次的浮水印。省略此參數可取得第一批修訂。

startDateTime: Date

用作修訂起點的日期/時間，所有修訂都將在此日期/時間之後發生。不能與“watermark”參數一起使用。

expand: ReportingRevisionsExpand

傳回

Promise<ReportingWorkItemRevisionsBatch>

replaceTemplate(WorkItemTemplate, string, string, string)

取代範本內容

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

參數

templateContent: WorkItemTemplate

要取代的範本內容

project: string

項目識別碼或項目名稱

team: string

團隊 ID 或團隊名稱

templateId: string

範本識別碼

傳回

Promise<WorkItemTemplate>

restoreWorkItem(WorkItemDeleteUpdate, number, string)

從資源回收筒還原已刪除的工作專案。

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

參數

payload: WorkItemDeleteUpdate

Paylod 的說明，將 IsDeleted 標誌更新為 false

id: number

要還原的工作專案標識碼

project: string

項目識別碼或項目名稱

傳回

Promise<WorkItemDelete>

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

搜尋使用者在目前專案中有權存取的所有查詢

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

參數

project: string

項目識別碼或項目名稱

filter: string

要篩選查詢的文字。

top: number

要傳回的查詢數目（預設值為 50，上限為 200）。

expand: QueryExpand

includeDeleted: boolean

包含已刪除的查詢和資料夾

傳回

Promise<QueryHierarchyItemsResult>

sendMail(SendMailBody, string)

RESTful 方法來傳送所選/查詢工作項目的郵件。

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

參數

body: SendMailBody

project: string

項目識別碼或項目名稱

傳回

Promise<void>

updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

更新現有的分類節點。

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

參數

postedNode: WorkItemClassificationNode

要建立或更新的節點。

project: string

項目識別碼或項目名稱

structureGroup: TreeStructureGroup

分類節點、區域或迭代的結構群組。

path: string

分類節點的路徑。

傳回

Promise<WorkItemClassificationNode>

updateField(UpdateWorkItemField, string, string)

更新欄位。

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

參數

payload: UpdateWorkItemField

承載包含欄位屬性的所需值

fieldNameOrRefName: string

要更新的欄位名稱/參考名稱

project: string

項目識別碼或項目名稱

傳回

Promise<WorkItemField>

updateQuery(QueryHierarchyItem, string, string, boolean)

更新查詢或資料夾。這可讓您更新、重新命名和移動查詢和資料夾。

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

參數

queryUpdate: QueryHierarchyItem

要更新的查詢。

project: string

項目識別碼或項目名稱

query: string

要更新的查詢的識別碼或路徑。

undeleteDescendants: boolean

取消刪除此資料夾的子項。請務必注意，這不會恢復先前套用至後代的權限變更。

傳回

Promise<QueryHierarchyItem>

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

更新單一工作專案。

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

參數

document: JsonPatchDocument

代表更新的 JSON 修補程式文件

id: number

要更新之工作專案的識別碼

project: string

項目識別碼或項目名稱

validateOnly: boolean

指出您是否只想驗證變更而不儲存工作專案

bypassRules: boolean

請勿在此更新上強制執行工作專案類型規則

suppressNotifications: boolean

請勿針對此變更引發任何通知

expand: WorkItemExpand

工作專案屬性的展開參數。可能的選項包括 { None、Relations、Fields、Links、All }。

傳回

Promise<WorkItem>

updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)

新增/更新工作專案類型

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

參數

updateModel: WorkItemTypeTemplateUpdateModel

project: string

項目識別碼或項目名稱

傳回

Promise<ProvisioningResult>

意見反應

此頁面對您有幫助嗎？

共用方式為

WorkItemTrackingRestClient class

建構函式

屬性

方法

建構函式詳細資料

WorkItemTrackingRestClient(IVssRestClientOptions)

參數

屬性詳細資料

RESOURCE_AREA_ID

屬性值

方法詳細資料

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

參數

傳回

createField(WorkItemField, string)

參數

傳回

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

參數

傳回

createQuery(QueryHierarchyItem, string, string, boolean)

參數

傳回

createTemplate(WorkItemTemplate, string, string)

參數

傳回

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

參數

傳回

deleteClassificationNode(string, TreeStructureGroup, string, number)

參數

傳回

deleteField(string, string)

參數

傳回

deleteQuery(string, string)

參數

傳回

deleteTemplate(string, string, string)

參數

傳回

deleteWorkItem(number, string, boolean)

參數

傳回

destroyWorkItem(number, string)

參數

傳回

exportWorkItemTypeDefinition(string, string, boolean)

參數

傳回

getAccountMyWorkData(QueryOption)

參數

傳回

getAttachmentContent(string, string, string, boolean)

參數

傳回

getAttachmentZip(string, string, string, boolean)

參數

傳回

getClassificationNode(string, TreeStructureGroup, string, number)

參數

傳回

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

參數

傳回

getComment(number, number, string)

參數

傳回

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

參數

傳回

getDeletedWorkItem(number, string)

參數

傳回

getDeletedWorkItems(number[], string)

參數

傳回

getDeletedWorkItemShallowReferences(string)

參數