Class WorkItemTrackingApi

constructor

• new WorkItemTrackingApi(
      baseUrl: string,
      handlers: IRequestHandler[],
      options?: IRequestOptions,
  ): WorkItemTrackingApi

  Parameters

  • baseUrl: string
  • handlers: IRequestHandler[]
  • Optionaloptions: IRequestOptions

  Returns WorkItemTrackingApi

Static ReadonlyRESOURCE_AREA_ID

addComment

• addComment(
      request: CommentCreate,
      project: string,
      workItemId: number,
  ): Promise<Comment>

  Add a comment on a work item.

  Parameters

  • request: CommentCreate

    Comment create request.
  • project: string

    Project ID or project name
  • workItemId: number

    Id of a work item.

  Returns Promise<Comment>

createAttachment

• createAttachment(
      customHeaders: any,
      contentStream: ReadableStream,
      fileName?: string,
      uploadType?: string,
      project?: string,
      areaPath?: string,
  ): Promise<AttachmentReference>

  Uploads an attachment.

  Parameters

  • customHeaders: any
  • contentStream: ReadableStream

    Content to upload
  • OptionalfileName: string

    The name of the file
  • OptionaluploadType: string

    Attachment upload type: Simple or Chunked
  • Optionalproject: string

    Project ID or project name
  • OptionalareaPath: string

    Target project Area Path

  Returns Promise<AttachmentReference>

createCommentReaction

• createCommentReaction(
      project: string,
      workItemId: number,
      commentId: number,
      reactionType: CommentReactionType,
  ): Promise<CommentReaction>

  Adds a new reaction to a comment.

  Parameters

  • project: string

    Project ID or project name
  • workItemId: number

    WorkItem ID
  • commentId: number

    Comment ID
  • reactionType: CommentReactionType

    Type of the reaction

  Returns Promise<CommentReaction>

createField

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

  Create a new field.

  Parameters

  • workItemField: WorkItemField

    New field definition
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WorkItemField>

createOrUpdateClassificationNode

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

  Create new or update an existing classification node.

  Parameters

  • postedNode: WorkItemClassificationNode

    Node to create or update.
  • project: string

    Project ID or project name
  • structureGroup: TreeStructureGroup

    Structure group of the classification node, area or iteration.
  • Optionalpath: string

    Path of the classification node.

  Returns Promise<WorkItemClassificationNode>

createQuery

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

  Creates a query, or moves a query.

  Parameters

  • postedQuery: QueryHierarchyItem

    The query to create.
  • project: string

    Project ID or project name
  • query: string

    The parent id or path under which the query is to be created.
  • OptionalvalidateWiqlOnly: boolean

    If you only want to validate your WIQL query without actually creating one, set it to true. Default is false.

  Returns Promise<QueryHierarchyItem>

createTemplate

• createTemplate(
      template: WorkItemTemplate,
      teamContext: TeamContext,
  ): Promise<WorkItemTemplate>

  Creates a template

  Parameters

  • template: WorkItemTemplate

    Template contents
  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<WorkItemTemplate>

createWorkItem

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

  Creates a single work item.

  Parameters

  • customHeaders: any
  • document: JsonPatchDocument

    The JSON Patch document representing the work item
  • project: string

    Project ID or project name
  • type: string

    The work item type of the work item to create
  • OptionalvalidateOnly: boolean

    Indicate if you only want to validate the changes without saving the work item
  • OptionalbypassRules: boolean

    Do not enforce the work item type rules on this update
  • OptionalsuppressNotifications: boolean

    Do not fire any notifications for this change
  • Optionalexpand: WorkItemExpand

    The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.

  Returns Promise<WorkItem>

deleteClassificationNode

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

  Delete an existing classification node.

  Parameters

  • project: string

    Project ID or project name
  • structureGroup: TreeStructureGroup

    Structure group of the classification node, area or iteration.
  • Optionalpath: string

    Path of the classification node.
  • OptionalreclassifyId: number

    Id of the target classification node for reclassification.

  Returns Promise<void>

deleteComment

• deleteComment(
      project: string,
      workItemId: number,
      commentId: number,
  ): Promise<void>

  Delete a comment on a work item.

  Parameters

  • project: string

    Project ID or project name
  • workItemId: number

    Id of a work item.
  • commentId: number

  Returns Promise<void>

deleteCommentReaction

• deleteCommentReaction(
      project: string,
      workItemId: number,
      commentId: number,
      reactionType: CommentReactionType,
  ): Promise<CommentReaction>

  Deletes an existing reaction on a comment.

  Parameters

  • project: string

    Project ID or project name
  • workItemId: number

    WorkItem ID
  • commentId: number

    Comment ID
  • reactionType: CommentReactionType

    Type of the reaction

  Returns Promise<CommentReaction>

deleteField

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

  Deletes the field. To undelete a filed, see "Update Field" API.

  Parameters

  • fieldNameOrRefName: string

    Field simple name or reference name
  • Optionalproject: string

    Project ID or project name

  Returns Promise<void>

deleteQuery

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

  Delete a query or a folder. This deletes any permission change on the deleted query or folder and any of its descendants if it is a folder. It is important to note that the deleted permission changes cannot be recovered upon undeleting the query or folder.

  Parameters

  • project: string

    Project ID or project name
  • query: string

    ID or path of the query or folder to delete.

  Returns Promise<void>

deleteTag

• deleteTag(project: string, tagIdOrName: string): Promise<void>

  Parameters

  • project: string

    Project ID or project name
  • tagIdOrName: string

  Returns Promise<void>

deleteTemplate

• deleteTemplate(teamContext: TeamContext, templateId: string): Promise<void>

  Deletes the template with given id

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • templateId: string

    Template id

  Returns Promise<void>

deleteWorkItem

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

  Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion. It is recommended NOT to use this parameter. If you do, please use this parameter with extreme caution.

  Parameters

  • id: number

    ID of the work item to be deleted
  • Optionalproject: string

    Project ID or project name
  • Optionaldestroy: boolean

    Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.

  Returns Promise<WorkItemDelete>

destroyWorkItem

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

  Destroys the specified work item permanently from the Recycle Bin. This action can not be undone.

  Parameters

  • id: number

    ID of the work item to be destroyed permanently
  • Optionalproject: string

    Project ID or project name

  Returns Promise<void>

exportWorkItemTypeDefinition

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

  Export work item type

  Parameters

  • Optionalproject: string

    Project ID or project name
  • Optionaltype: string
  • OptionalexportGlobalLists: boolean

  Returns Promise<WorkItemTypeTemplate>

getAccountMyWorkData

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

  INTERNAL ONLY: USED BY ACCOUNT MY WORK PAGE. This returns Doing, Done, Follows and activity work items details.

  Parameters

  • OptionalqueryOption: QueryOption

  Returns Promise<AccountMyWorkResult>

getAttachmentContent

• getAttachmentContent(
      id: string,
      fileName?: string,
      project?: string,
      download?: boolean,
  ): Promise<ReadableStream>

  Downloads an attachment.

  Parameters

  • id: string

    Attachment ID
  • OptionalfileName: string

    Name of the file
  • Optionalproject: string

    Project ID or project name
  • Optionaldownload: boolean

    If set to true always download attachment

  Returns Promise<ReadableStream>

getAttachmentZip

• getAttachmentZip(
      id: string,
      fileName?: string,
      project?: string,
      download?: boolean,
  ): Promise<ReadableStream>

  Downloads an attachment.

  Parameters

  • id: string

    Attachment ID
  • OptionalfileName: string

    Name of the file
  • Optionalproject: string

    Project ID or project name
  • Optionaldownload: boolean

    If set to true always download attachment

  Returns Promise<ReadableStream>

getClassificationNode

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

  Gets the classification node for a given node path.

  Parameters

  • project: string

    Project ID or project name
  • structureGroup: TreeStructureGroup

    Structure group of the classification node, area or iteration.
  • Optionalpath: string

    Path of the classification node.
  • Optionaldepth: number

    Depth of children to fetch.

  Returns Promise<WorkItemClassificationNode>

getClassificationNodes

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

  Gets root classification nodes or list of classification nodes for a given list of nodes ids, for a given project. In case ids parameter is supplied you will get list of classification nodes for those ids. Otherwise you will get root classification nodes for this project.

  Parameters

  • project: string

    Project ID or project name
  • ids: number[]

    Comma separated integer classification nodes ids. It's not required, if you want root nodes.
  • Optionaldepth: number

    Depth of children to fetch.
  • OptionalerrorPolicy: ClassificationNodesErrorPolicy

    Flag to handle errors in getting some nodes. Possible options are Fail and Omit.

  Returns Promise<WorkItemClassificationNode[]>

getComment

• getComment(
      project: string,
      workItemId: number,
      commentId: number,
      includeDeleted?: boolean,
      expand?: CommentExpandOptions,
  ): Promise<Comment>

  Returns a work item comment.

  Parameters

  • project: string

    Project ID or project name
  • workItemId: number

    Id of a work item to get the comment.
  • commentId: number

    Id of the comment to return.
  • OptionalincludeDeleted: boolean

    Specify if the deleted comment should be retrieved.
  • Optionalexpand: CommentExpandOptions

    Specifies the additional data retrieval options for work item comments.

  Returns Promise<Comment>

getCommentReactions

• getCommentReactions(
      project: string,
      workItemId: number,
      commentId: number,
  ): Promise<CommentReaction[]>

  Gets reactions of a comment.

  Parameters

  • project: string

    Project ID or project name
  • workItemId: number

    WorkItem ID
  • commentId: number

    Comment ID

  Returns Promise<CommentReaction[]>

getComments

• getComments(
      project: string,
      workItemId: number,
      top?: number,
      continuationToken?: string,
      includeDeleted?: boolean,
      expand?: CommentExpandOptions,
      order?: CommentSortOrder,
  ): Promise<CommentList>

  Returns a list of work item comments, pageable.

  Parameters

  • project: string

    Project ID or project name
  • workItemId: number

    Id of a work item to get comments for.
  • Optionaltop: number

    Max number of comments to return.
  • OptionalcontinuationToken: string

    Used to query for the next page of comments.
  • OptionalincludeDeleted: boolean

    Specify if the deleted comments should be retrieved.
  • Optionalexpand: CommentExpandOptions

    Specifies the additional data retrieval options for work item comments.
  • Optionalorder: CommentSortOrder

    Order in which the comments should be returned.

  Returns Promise<CommentList>

getCommentsBatch

• getCommentsBatch(
      project: string,
      workItemId: number,
      ids: number[],
      includeDeleted?: boolean,
      expand?: CommentExpandOptions,
  ): Promise<CommentList>

  Returns a list of work item comments by ids.

  Parameters

  • project: string

    Project ID or project name
  • workItemId: number

    Id of a work item to get comments for.
  • ids: number[]

    Comma-separated list of comment ids to return.
  • OptionalincludeDeleted: boolean

    Specify if the deleted comments should be retrieved.
  • Optionalexpand: CommentExpandOptions

    Specifies the additional data retrieval options for work item comments.

  Returns Promise<CommentList>

getCommentVersion

• getCommentVersion(
      project: string,
      workItemId: number,
      commentId: number,
      version: number,
  ): Promise<CommentVersion>

  Parameters

  • project: string

    Project ID or project name
  • workItemId: number
  • commentId: number
  • version: number

  Returns Promise<CommentVersion>

getCommentVersions

• getCommentVersions(
      project: string,
      workItemId: number,
      commentId: number,
  ): Promise<CommentVersion[]>

  Parameters

  • project: string

    Project ID or project name
  • workItemId: number
  • commentId: number

  Returns Promise<CommentVersion[]>

getDeletedWorkItem

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

  Gets a deleted work item from Recycle Bin.

  Parameters

  • id: number

    ID of the work item to be returned
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WorkItemDelete>

getDeletedWorkItems

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

  Gets the work items from the recycle bin, whose IDs have been specified in the parameters

  Parameters

  • ids: number[]

    Comma separated list of IDs of the deleted work items to be returned
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WorkItemDeleteReference[]>

getDeletedWorkItemShallowReferences

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

  Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin.

  Parameters

  • Optionalproject: string

    Project ID or project name

  Returns Promise<WorkItemDeleteShallowReference[]>

getEngagedUsers

• getEngagedUsers(
      project: string,
      workItemId: number,
      commentId: number,
      reactionType: CommentReactionType,
      top?: number,
      skip?: number,
  ): Promise<IdentityRef[]>

  Get users who reacted on the comment.

  Parameters

  • project: string

    Project ID or project name
  • workItemId: number

    WorkItem ID.
  • commentId: number

    Comment ID.
  • reactionType: CommentReactionType

    Type of the reaction.
  • Optionaltop: number
  • Optionalskip: number

  Returns Promise<IdentityRef[]>

getField

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

  Gets information on a specific field.

  Parameters

  • fieldNameOrRefName: string

    Field simple name or reference name
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WorkItemField>

getFields

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

  Returns information for all fields. The project ID/name parameter is optional.

  Parameters

  • Optionalproject: string

    Project ID or project name
  • Optionalexpand: GetFieldsExpand

    Use ExtensionFields to include extension fields, otherwise exclude them. Unless the feature flag for this parameter is enabled, extension fields are always included.

  Returns Promise<WorkItemField[]>

getQueries

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

  Gets the root queries and their children

  Parameters

  • project: string

    Project ID or project name
  • Optionalexpand: QueryExpand

    Include the query string (wiql), clauses, query result columns, and sort options in the results.
  • Optionaldepth: number

    In the folder of queries, return child queries and folders to this depth.
  • OptionalincludeDeleted: boolean

    Include deleted queries and folders

  Returns Promise<QueryHierarchyItem[]>

getQueriesBatch

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

  Gets a list of queries by ids (Maximum 1000)

  Parameters

  • queryGetRequest: QueryBatchGetRequest
  • project: string

    Project ID or project name

  Returns Promise<QueryHierarchyItem[]>

getQuery

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

  Retrieves an individual query and its children

  Parameters

  • project: string

    Project ID or project name
  • query: string

    ID or path of the query.
  • Optionalexpand: QueryExpand

    Include the query string (wiql), clauses, query result columns, and sort options in the results.
  • Optionaldepth: number

    In the folder of queries, return child queries and folders to this depth.
  • OptionalincludeDeleted: boolean

    Include deleted queries and folders
  • OptionaluseIsoDateFormat: boolean

    DateTime query clauses will be formatted using a ISO 8601 compliant format

  Returns Promise<QueryHierarchyItem>

getRecentActivityData

• getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

  Gets recent work item activities

  Returns Promise<AccountRecentActivityWorkItemModel2[]>

getRecentMentions

• getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

  INTERNAL ONLY: USED BY ACCOUNT MY WORK PAGE.

  Returns Promise<AccountRecentMentionWorkItemModel[]>

getRelationType

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

  Gets the work item relation type definition.

  Parameters

  • relation: string

    The relation name

  Returns Promise<WorkItemRelationType>

getRelationTypes

• getRelationTypes(): Promise<WorkItemRelationType[]>

  Gets the work item relation types.

  Returns Promise<WorkItemRelationType[]>

getReportingLinksByLinkType

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

  Get a batch of work item links

  Parameters

  • Optionalproject: string

    Project ID or project name
  • OptionallinkTypes: string[]

    A list of types to filter the results to specific link types. Omit this parameter to get work item links of all link types.
  • Optionaltypes: string[]

    A list of types to filter the results to specific work item types. Omit this parameter to get work item links of all work item types.
  • OptionalcontinuationToken: string

    Specifies the continuationToken to start the batch from. Omit this parameter to get the first batch of links.
  • OptionalstartDateTime: Date

    Date/time to use as a starting point for link changes. Only link changes that occurred after that date/time will be returned. Cannot be used in conjunction with 'watermark' parameter.

  Returns Promise<ReportingWorkItemLinksBatch>

getRevision

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

  Returns a fully hydrated work item for the requested revision

  Parameters

  • id: number
  • revisionNumber: number
  • Optionalexpand: WorkItemExpand
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WorkItem>

getRevisions

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

  Returns the list of fully hydrated work item revisions, paged.

  Parameters

  • id: number
  • Optionaltop: number
  • Optionalskip: number
  • Optionalexpand: WorkItemExpand
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WorkItem[]>

getRootNodes

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

  Gets root classification nodes under the project.

  Parameters

  • project: string

    Project ID or project name
  • Optionaldepth: number

    Depth of children to fetch.

  Returns Promise<WorkItemClassificationNode[]>

getTag

• getTag(project: string, tagIdOrName: string): Promise<WorkItemTagDefinition>

  Parameters

  • project: string

    Project ID or project name
  • tagIdOrName: string

  Returns Promise<WorkItemTagDefinition>

getTags

• getTags(project: string): Promise<WorkItemTagDefinition[]>

  Parameters

  • project: string

    Project ID or project name

  Returns Promise<WorkItemTagDefinition[]>

getTemplate

• getTemplate(
      teamContext: TeamContext,
      templateId: string,
  ): Promise<WorkItemTemplate>

  Gets the template with specified id

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • templateId: string

    Template Id

  Returns Promise<WorkItemTemplate>

getTemplates

• getTemplates(
      teamContext: TeamContext,
      workitemtypename?: string,
  ): Promise<WorkItemTemplateReference[]>

  Gets template

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • Optionalworkitemtypename: string

    Optional, When specified returns templates for given Work item type.

  Returns Promise<WorkItemTemplateReference[]>

getUpdate

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

  Returns a single update for a work item

  Parameters

  • id: number
  • updateNumber: number
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WorkItemUpdate>

getUpdates

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

  Returns a the deltas between work item revisions

  Parameters

  • id: number
  • Optionaltop: number
  • Optionalskip: number
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WorkItemUpdate[]>

getWorkArtifactLinkTypes

• getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

  Get the list of work item tracking outbound artifact link types.

  Returns Promise<WorkArtifactLink[]>

getWorkItem

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

  Returns a single work item.

  Parameters

  • id: number

    The work item id
  • Optionalfields: string[]

    Comma-separated list of requested fields
  • OptionalasOf: Date

    AsOf UTC date time string
  • Optionalexpand: WorkItemExpand

    The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WorkItem>

getWorkItemIconJson

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

  Get a work item icon given the friendly name and icon color.

  Parameters

  • icon: string

    The name of the icon
  • Optionalcolor: string

    The 6-digit hex color for the icon
  • Optionalv: number

    The version of the icon (used only for cache invalidation)

  Returns Promise<WorkItemIcon>

getWorkItemIcons

• getWorkItemIcons(): Promise<WorkItemIcon[]>

  Get a list of all work item icons.

  Returns Promise<WorkItemIcon[]>

getWorkItemIconSvg

• getWorkItemIconSvg(
      icon: string,
      color?: string,
      v?: number,
  ): Promise<ReadableStream>

  Get a work item icon given the friendly name and icon color.

  Parameters

  • icon: string

    The name of the icon
  • Optionalcolor: string

    The 6-digit hex color for the icon
  • Optionalv: number

    The version of the icon (used only for cache invalidation)

  Returns Promise<ReadableStream>

getWorkItemIconXaml

• getWorkItemIconXaml(
      icon: string,
      color?: string,
      v?: number,
  ): Promise<ReadableStream>

  Get a work item icon given the friendly name and icon color.

  Parameters

  • icon: string

    The name of the icon
  • Optionalcolor: string

    The 6-digit hex color for the icon
  • Optionalv: number

    The version of the icon (used only for cache invalidation)

  Returns Promise<ReadableStream>

getWorkItemNextStatesOnCheckinAction

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

  Returns the next state on the given work item IDs.

  Parameters

  • ids: number[]

    list of work item ids
  • Optionalaction: string

    possible actions. Currently only supports checkin

  Returns Promise<WorkItemNextStateOnTransition[]>

getWorkItems

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

  Returns a list of work items (Maximum 200)

  Parameters

  • ids: number[]

    The comma-separated list of requested work item ids. (Maximum 200 ids allowed).
  • Optionalfields: string[]

    Comma-separated list of requested fields
  • OptionalasOf: Date

    AsOf UTC date time string
  • Optionalexpand: WorkItemExpand

    The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.
  • OptionalerrorPolicy: WorkItemErrorPolicy

    The flag to control error policy in a bulk get work items request. Possible options are {Fail, Omit}.
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WorkItem[]>

getWorkItemsBatch

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

  Gets work items for a list of work item ids (Maximum 200)

  Parameters

  • workItemGetRequest: WorkItemBatchGetRequest
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WorkItem[]>

getWorkItemStateColors

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

  INTERNAL ONLY: It will be used for My account work experience. Get the work item type state color for multiple projects

  Parameters

  • projectNames: string[]

  Returns Promise<ProjectWorkItemStateColors[]>

getWorkItemTemplate

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

  Returns a single work item from a template.

  Parameters

  • project: string

    Project ID or project name
  • type: string

    The work item type name
  • Optionalfields: string

    Comma-separated list of requested fields
  • OptionalasOf: Date

    AsOf UTC date time string
  • Optionalexpand: WorkItemExpand

    The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.

  Returns Promise<WorkItem>

getWorkItemType

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

  Returns a work item type definition.

  Parameters

  • project: string

    Project ID or project name
  • type: string

    Work item type name

  Returns Promise<WorkItemType>

getWorkItemTypeCategories

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

  Get all work item type categories.

  Parameters

  • project: string

    Project ID or project name

  Returns Promise<WorkItemTypeCategory[]>

getWorkItemTypeCategory

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

  Get specific work item type category by name.

  Parameters

  • project: string

    Project ID or project name
  • category: string

    The category name

  Returns Promise<WorkItemTypeCategory>

getWorkItemTypeColorAndIcons

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

  INTERNAL ONLY: It is used for color and icon providers. Get the wit type color for multiple projects

  Parameters

  • projectNames: string[]

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

getWorkItemTypeColors

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

  INTERNAL ONLY: It will be used for My account work experience. Get the wit type color for multiple projects

  Parameters

  • projectNames: string[]

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

getWorkItemTypeFieldsWithReferences

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

  Get a list of fields for a work item type with detailed references.

  Parameters

  • project: string

    Project ID or project name
  • type: string

    Work item type.
  • Optionalexpand: WorkItemTypeFieldsExpandLevel

    Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.

  Returns Promise<WorkItemTypeFieldWithReferences[]>

getWorkItemTypeFieldWithReferences

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

  Get a field for a work item type with detailed references.

  Parameters

  • project: string

    Project ID or project name
  • type: string

    Work item type.
  • field: string
  • Optionalexpand: WorkItemTypeFieldsExpandLevel

    Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.

  Returns Promise<WorkItemTypeFieldWithReferences>

getWorkItemTypes

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

  Returns the list of work item types

  Parameters

  • project: string

    Project ID or project name

  Returns Promise<WorkItemType[]>

getWorkItemTypeStates

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

  Returns the state names and colors for a work item type.

  Parameters

  • project: string

    Project ID or project name
  • type: string

    The state name

  Returns Promise<WorkItemStateColor[]>

migrateProjectsProcess

• migrateProjectsProcess(
      newProcess: ProcessIdModel,
      project: string,
  ): Promise<ProcessMigrationResultModel>

  Migrates a project to a different process within the same OOB type. For example, you can only migrate a project from agile/custom-agile to agile/custom-agile.

  Parameters

  • newProcess: ProcessIdModel
  • project: string

    Project ID or project name

  Returns Promise<ProcessMigrationResultModel>

queryById

• queryById(
      id: string,
      teamContext?: TeamContext,
      timePrecision?: boolean,
      top?: number,
  ): Promise<WorkItemQueryResult>

  Gets the results of the query given the query ID.

  Parameters

  • id: string

    The query ID.
  • OptionalteamContext: TeamContext

    The team context for the operation
  • OptionaltimePrecision: boolean

    Whether or not to use time precision.
  • Optionaltop: number

    The max number of results to return.

  Returns Promise<WorkItemQueryResult>

queryByWiql

• queryByWiql(
      wiql: Wiql,
      teamContext?: TeamContext,
      timePrecision?: boolean,
      top?: number,
  ): Promise<WorkItemQueryResult>

  Gets the results of the query given its WIQL.

  Parameters

  • wiql: Wiql

    The query containing the WIQL.
  • OptionalteamContext: TeamContext

    The team context for the operation
  • OptionaltimePrecision: boolean

    Whether or not to use time precision.
  • Optionaltop: number

    The max number of results to return.

  Returns Promise<WorkItemQueryResult>

queryWorkItemsForArtifactUris

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

  Queries work items linked to a given list of artifact URI.

  Parameters

  • artifactUriQuery: ArtifactUriQuery

    Defines a list of artifact URI for querying work items.
  • Optionalproject: string

    Project ID or project name

  Returns Promise<ArtifactUriQueryResult>

readReportingDiscussions

• readReportingDiscussions(
      project?: string,
      continuationToken?: string,
      maxPageSize?: number,
  ): Promise<ReportingWorkItemRevisionsBatch>

  Parameters

  • Optionalproject: string

    Project ID or project name
  • OptionalcontinuationToken: string
  • OptionalmaxPageSize: number

  Returns Promise<ReportingWorkItemRevisionsBatch>

readReportingRevisionsGet

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

  Get a batch of work item revisions with the option of including deleted items

  Parameters

  • Optionalproject: string

    Project ID or project name
  • Optionalfields: string[]

    A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.
  • Optionaltypes: string[]

    A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.
  • OptionalcontinuationToken: string

    Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.
  • OptionalstartDateTime: Date

    Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.
  • OptionalincludeIdentityRef: boolean

    Return an identity reference instead of a string value for identity fields.
  • OptionalincludeDeleted: boolean

    Specify if the deleted item should be returned.
  • OptionalincludeTagRef: boolean

    Specify if the tag objects should be returned for System.Tags field.
  • OptionalincludeLatestOnly: boolean

    Return only the latest revisions of work items, skipping all historical revisions
  • Optionalexpand: ReportingRevisionsExpand

    Return all the fields in work item revisions, including long text fields which are not returned by default
  • OptionalincludeDiscussionChangesOnly: boolean

    Return only the those revisions of work items, where only history field was changed
  • OptionalmaxPageSize: number

    The maximum number of results to return in this batch

  Returns Promise<ReportingWorkItemRevisionsBatch>

readReportingRevisionsPost

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

  Get a batch of work item revisions. This request may be used if your list of fields is large enough that it may run the URL over the length limit.

  Parameters

  • filter: ReportingWorkItemRevisionsFilter

    An object that contains request settings: field filter, type filter, identity format
  • Optionalproject: string

    Project ID or project name
  • OptionalcontinuationToken: string

    Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.
  • OptionalstartDateTime: Date

    Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.
  • Optionalexpand: ReportingRevisionsExpand

  Returns Promise<ReportingWorkItemRevisionsBatch>

replaceTemplate

• replaceTemplate(
      templateContent: WorkItemTemplate,
      teamContext: TeamContext,
      templateId: string,
  ): Promise<WorkItemTemplate>

  Replace template contents

  Parameters

  • templateContent: WorkItemTemplate

    Template contents to replace with
  • teamContext: TeamContext

    The team context for the operation
  • templateId: string

    Template id

  Returns Promise<WorkItemTemplate>

restoreWorkItem

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

  Restores the deleted work item from Recycle Bin.

  Parameters

  • payload: WorkItemDeleteUpdate

    Paylod with instructions to update the IsDeleted flag to false
  • id: number

    ID of the work item to be restored
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WorkItemDelete>

searchQueries

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

  Searches all queries the user has access to in the current project

  Parameters

  • project: string

    Project ID or project name
  • filter: string

    The text to filter the queries with.
  • Optionaltop: number

    The number of queries to return (Default is 50 and maximum is 200).
  • Optionalexpand: QueryExpand
  • OptionalincludeDeleted: boolean

    Include deleted queries and folders

  Returns Promise<QueryHierarchyItemsResult>

sendMail

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

  RESTful method to send mail for selected/queried work items.

  Parameters

  • body: SendMailBody
  • Optionalproject: string

    Project ID or project name

  Returns Promise<void>

updateClassificationNode

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

  Update an existing classification node.

  Parameters

  • postedNode: WorkItemClassificationNode

    Node to create or update.
  • project: string

    Project ID or project name
  • structureGroup: TreeStructureGroup

    Structure group of the classification node, area or iteration.
  • Optionalpath: string

    Path of the classification node.

  Returns Promise<WorkItemClassificationNode>

updateComment

• updateComment(
      request: CommentUpdate,
      project: string,
      workItemId: number,
      commentId: number,
  ): Promise<Comment>

  Update a comment on a work item.

  Parameters

  • request: CommentUpdate

    Comment update request.
  • project: string

    Project ID or project name
  • workItemId: number

    Id of a work item.
  • commentId: number

  Returns Promise<Comment>

updateField

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

  Update a field.

  Parameters

  • payload: UpdateWorkItemField

    Payload contains desired value of the field's properties
  • fieldNameOrRefName: string

    Name/reference name of the field to be updated
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WorkItemField>

updateQuery

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

  Update a query or a folder. This allows you to update, rename and move queries and folders.

  Parameters

  • queryUpdate: QueryHierarchyItem

    The query to update.
  • project: string

    Project ID or project name
  • query: string

    The ID or path for the query to update.
  • OptionalundeleteDescendants: boolean

    Undelete the children of this folder. It is important to note that this will not bring back the permission changes that were previously applied to the descendants.

  Returns Promise<QueryHierarchyItem>

updateTag

• updateTag(
      tagData: WorkItemTagDefinition,
      project: string,
      tagIdOrName: string,
  ): Promise<WorkItemTagDefinition>

  Parameters

  • tagData: WorkItemTagDefinition
  • project: string

    Project ID or project name
  • tagIdOrName: string

  Returns Promise<WorkItemTagDefinition>

updateWorkItem

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

  Updates a single work item.

  Parameters

  • customHeaders: any
  • document: JsonPatchDocument

    The JSON Patch document representing the update
  • id: number

    The id of the work item to update
  • Optionalproject: string

    Project ID or project name
  • OptionalvalidateOnly: boolean

    Indicate if you only want to validate the changes without saving the work item
  • OptionalbypassRules: boolean

    Do not enforce the work item type rules on this update
  • OptionalsuppressNotifications: boolean

    Do not fire any notifications for this change
  • Optionalexpand: WorkItemExpand

    The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.

  Returns Promise<WorkItem>

updateWorkItemTypeDefinition

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

  Add/updates a work item type

  Parameters

  • updateModel: WorkItemTypeTemplateUpdateModel
  • Optionalproject: string

    Project ID or project name

  Returns Promise<ProvisioningResult>