WorkItemTrackingRestClient class

包:

azure-devops-extension-api

应使用 (派生自) 的基类向 VSS REST API 发出请求

Extends

RestClientBase

构造函数

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)	删除 字段。 若要取消删除存档，请参阅“更新字段”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)	从回收站获取工作项，其 ID 已在参数中指定
getDeletedWorkItemShallowReferences(string)	获取回收站中已删除的工作项的 ID 和 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)	获取给定查询 ID 的查询结果。
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)	获取具有指定 ID 的模板
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)	返回给定工作项 ID 上的下一个状态。
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)	返回最多 200) (工作项的列表
getWorkItemsBatch(WorkItemBatchGetRequest, string)	获取工作项 ID 列表的工作项 (最大为 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)	获取给定查询 ID 的查询结果。
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

项目 ID 或项目名称

fileName

string

文件的名称

uploadType

string

附件上传类型：简单或分块

areaPath

string

目标项目区域路径

返回

Promise<AttachmentReference>

createField(WorkItemField, string)

创建新字段。

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

参数

workItemField

WorkItemField

新字段定义

project

string

项目 ID 或项目名称

返回

Promise<WorkItemField>

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

新建或更新现有分类节点。

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

参数

postedNode

WorkItemClassificationNode

要创建或更新的节点。

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

query

string

要在其中创建查询的父 ID 或路径。

validateWiqlOnly

boolean

如果只想验证 WIQL 查询而不实际创建一个查询，请将其设置为 true。 默认值为 false。

返回

Promise<QueryHierarchyItem>

createTemplate(WorkItemTemplate, string, string)

创建模板

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

参数

template

WorkItemTemplate

模板内容

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

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

项目 ID 或项目名称

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

项目 ID 或项目名称

返回

Promise<void>

deleteQuery(string, string)

删除查询或文件夹。 这将删除对已删除的查询或文件夹及其任何后代（如果是文件夹）的任何权限更改。 请务必注意，在取消删除查询或文件夹时，无法恢复已删除的权限更改。

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

参数

project

string

项目 ID 或项目名称

query

string

要删除的查询或文件夹的 ID 或路径。

返回

Promise<void>

deleteTemplate(string, string, string)

删除具有给定 ID 的模板

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

参数

project

string

项目 ID 或项目名称

team

string

团队 ID 或团队名称

templateId

string

模板 ID

返回

Promise<void>

deleteWorkItem(number, string, boolean)

删除指定的工作项并将其发送到回收站，以便在需要时可以还原它。 （可选）如果 destroy 参数已设置为 true，它将永久销毁工作项。 警告：如果 destroy 参数设置为 true，则此命令删除的工作项不会转到回收站，并且无法在删除后还原/恢复它们。 建议不要使用此参数。 如果这样做，请谨慎使用此参数。

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

参数

id

number

要删除的工作项的 ID

project

string

项目 ID 或项目名称

destroy

boolean

可选参数，如果设置为 true，则永久删除工作项。 请注意：销毁操作是永久性操作，无法撤消。

返回

Promise<WorkItemDelete>

destroyWorkItem(number, string)

从回收站永久销毁指定的工作项。 此操作无法撤消。

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

参数

id

number

要永久销毁的工作项的 ID

project

string

项目 ID 或项目名称

返回

Promise<void>

exportWorkItemTypeDefinition(string, string, boolean)

导出工作项类型

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

参数

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

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

项目 ID 或项目名称

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

项目 ID 或项目名称

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

项目 ID 或项目名称

ids

number[]

逗号分隔的整数分类节点 ID。 如果需要根节点，则不是必需的。

depth

number

要提取的子级的深度。

errorPolicy

ClassificationNodesErrorPolicy

用于处理获取某些节点时出现的错误的标志。 可能的选项包括“失败”和“省略”。

返回

Promise<WorkItemClassificationNode[]>

getComment(number, number, string)

获取指定修订处的工作项的注释。

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

参数

id

number

工作项 ID

revision

number

需要提取注释的修订

project

string

项目 ID 或项目名称

返回

Promise<WorkItemComment>

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

从指定的修订中获取工作项的指定数量的注释。

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

参数

id

number

工作项 ID

project

string

项目 ID 或项目名称

fromRevision

number

要从中提取注释的修订 (默认值为 1)

top

number

要返回的注释数 (默认值为 200)

order

CommentSortOrder

按修订 ID 升序或降序 (默认值为升序)

返回

Promise<WorkItemComments>

getDeletedWorkItem(number, string)

从回收站获取已删除的工作项。

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

参数

id

number

要返回的工作项的 ID

project

string

项目 ID 或项目名称

返回

Promise<WorkItemDelete>

getDeletedWorkItems(number[], string)

从回收站获取工作项，其 ID 已在参数中指定

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

参数

ids

number[]

要返回的已删除工作项的 ID 的逗号分隔列表

project

string

项目 ID 或项目名称

返回

Promise<WorkItemDeleteReference[]>

getDeletedWorkItemShallowReferences(string)

获取回收站中已删除的工作项的 ID 和 URL 的列表。

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

参数

project

string

项目 ID 或项目名称

返回

Promise<WorkItemDeleteShallowReference[]>

getField(string, string)

获取有关特定字段的信息。

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

参数

fieldNameOrRefName

string

字段简单名称或引用名称

project

string

项目 ID 或项目名称

返回

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

返回所有字段的信息。 项目 ID/名称参数是可选的。

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

参数

project

string

项目 ID 或项目名称

expand

GetFieldsExpand

使用 ExtensionFields 可包含扩展字段，否则将其排除。 除非启用此参数的功能标志，否则始终包含扩展字段。

返回

Promise<WorkItemField[]>

getQueries(string, QueryExpand, number, boolean)

获取根查询及其子查询

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

参数

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

返回

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

项目 ID 或项目名称

query

string

查询的 ID 或路径。

expand

QueryExpand

在结果中包括查询字符串 (wiql) 、子句、查询结果列和排序选项。

depth

number

在查询的 文件夹中，将子查询和文件夹返回到此深度。

includeDeleted

boolean

包括已删除的查询和文件夹

useIsoDateFormat

boolean

DateTime 查询子句将使用符合 ISO 8601 的格式进行格式化

返回

Promise<QueryHierarchyItem>

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

获取给定查询 ID 的查询结果。

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

参数

id

string

查询 ID。

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

linkTypes

string[]

用于将结果筛选为特定链接类型的类型列表。 省略此参数可获取所有链接类型的工作项链接。

types

string[]

用于将结果筛选为特定工作项类型的类型列表。 省略此参数可获取所有工作项类型的工作项链接。

continuationToken

string

指定要从其启动批处理的 continuationToken。 省略此参数可获取第一批链接。

startDateTime

Date

用作链接更改起点的日期/时间。 仅返回在该日期/时间之后发生的链接更改。 不能与“水印”参数结合使用。

返回

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

项目 ID 或项目名称

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

项目 ID 或项目名称

top

number

skip

number

expand

WorkItemExpand

返回

Promise<WorkItem[]>

getRootNodes(string, number)

获取项目下的根分类节点。

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

参数

project

string

项目 ID 或项目名称

depth

number

要提取的子级的深度。

返回

Promise<WorkItemClassificationNode[]>

getTemplate(string, string, string)

获取具有指定 ID 的模板

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

参数

project

string

项目 ID 或项目名称

team

string

团队 ID 或团队名称

templateId

string

模板 ID

返回

Promise<WorkItemTemplate>

getTemplates(string, string, string)

获取模板

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

参数

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

返回

Promise<WorkItemUpdate>

getUpdates(number, string, number, number)

返回工作项修订之间的增量

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

参数

id

number

project

string

项目 ID 或项目名称

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

工作项 ID

project

string

项目 ID 或项目名称

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)

返回给定工作项 ID 上的下一个状态。

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

参数

ids

number[]

工作项 ID 列表

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

请求的工作项 ID 的逗号分隔列表。 (最多允许) 200 个 ID。

project

string

项目 ID 或项目名称

fields

string[]

以逗号分隔的请求字段列表

asOf

Date

AsOf UTC 日期时间字符串

expand

WorkItemExpand

工作项属性的展开参数。 可能的选项包括 { None、Relations、Fields、Links、All }。

errorPolicy

WorkItemErrorPolicy

用于控制批量获取工作项请求中的错误策略的标志。 可能的选项为 {Fail， Omit}。

返回

Promise<WorkItem[]>

getWorkItemsBatch(WorkItemBatchGetRequest, string)

获取工作项 ID 列表的工作项 (最大为 200)

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

参数

workItemGetRequest

WorkItemBatchGetRequest

project

string

项目 ID 或项目名称

返回

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

项目 ID 或项目名称

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

项目 ID 或项目名称

type

string

工作项类型名称

返回

Promise<WorkItemType>

getWorkItemTypeCategories(string)

获取所有工作项类型类别。

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

参数

project

string

项目 ID 或项目名称

返回

Promise<WorkItemTypeCategory[]>

getWorkItemTypeCategory(string, string)

按名称获取特定工作项类型类别。

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

参数

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

type

string

工作项类型。

expand

WorkItemTypeFieldsExpandLevel

展开 API 响应的级别。 属性：在响应中包括 allowedvalues、默认值、isRequired 等;无：跳过这些属性。

返回

Promise<WorkItemTypeFieldWithReferences[]>

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

获取具有详细引用的工作项类型的字段。

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

参数

project

string

项目 ID 或项目名称

type

string

工作项类型。

field

string

expand

WorkItemTypeFieldsExpandLevel

展开 API 响应的级别。 属性：在响应中包括 allowedvalues、默认值、isRequired 等;无：跳过这些属性。

返回

Promise<WorkItemTypeFieldWithReferences>

getWorkItemTypes(string)

返回工作项类型的列表

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

参数

project

string

项目 ID 或项目名称

返回

Promise<WorkItemType[]>

getWorkItemTypeStates(string, string)

返回工作项类型的状态名称和颜色。

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

参数

project

string

项目 ID 或项目名称

type

string

州名称

返回

Promise<WorkItemStateColor[]>

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

获取给定查询 ID 的查询结果。

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

参数

id

string

查询 ID。

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

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

项目 ID 或项目名称

返回

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

项目 ID 或项目名称

fields

string[]

工作项修订中要返回的字段列表。 省略此参数可获取所有可报告字段。

types

string[]

用于将结果筛选为特定工作项类型的类型列表。 省略此参数可获取所有工作项类型的工作项修订。

continuationToken

string

指定要从其开始批处理的水印。 省略此参数可获取第一批修订。

startDateTime

Date

要用作修订起点的日期/时间，所有修订都将在此日期/时间之后发生。 不能与“水印”参数结合使用。

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

项目 ID 或项目名称

continuationToken

string

指定要从其开始批处理的水印。 省略此参数可获取第一批修订。

startDateTime

Date

要用作修订起点的日期/时间，所有修订都将在此日期/时间之后发生。 不能与“水印”参数结合使用。

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

项目 ID 或项目名称

team

string

团队 ID 或团队名称

templateId

string

模板 ID

返回

Promise<WorkItemTemplate>

restoreWorkItem(WorkItemDeleteUpdate, number, string)

从回收站还原已删除的工作项。

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

参数

payload

WorkItemDeleteUpdate

Paylod，其中包含将 IsDeleted 标志更新为 false 的说明

id

number

要还原的工作项的 ID

project

string

项目 ID 或项目名称

返回

Promise<WorkItemDelete>

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

在当前项目中搜索用户有权访问的所有查询

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

参数

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

返回

Promise<void>

updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

更新现有分类节点。

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

参数

postedNode

WorkItemClassificationNode

要创建或更新的节点。

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

返回

Promise<WorkItemField>

updateQuery(QueryHierarchyItem, string, string, boolean)

更新查询或文件夹。 这使你可以更新、重命名和移动查询和文件夹。

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

参数

queryUpdate

QueryHierarchyItem

要更新的查询。

project

string

项目 ID 或项目名称

query

string

要更新的查询的 ID 或路径。

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

要更新的工作项的 ID

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

返回

Promise<ProvisioningResult>