Поделиться через


WorkItemTrackingRestClient class

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends

Конструкторы

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)

ТОЛЬКО ВНУТРЕННИЙ: ИСПОЛЬЗУЕТСЯ УЧЕТНОЙ ЗАПИСЬЮ СТРАНИЦА МОЯ РАБОТА. При этом возвращаются сведения о рабочих элементах Doing, Done, Follows и рабочих элементах действия.

getAttachmentContent(string, string, string, boolean)

Загружает вложение.

getAttachmentZip(string, string, string, boolean)

Загружает вложение.

getClassificationNode(string, TreeStructureGroup, string, number)

Получает классификационный узел для заданного пути к узлу.

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

Получает корневые узлы классификации или список узлов классификации для заданного списка идентификаторов узлов для данного проекта. Если параметр ids указан, вы получите список узлов классификации для этих идентификаторов. В противном случае вы получите корневые узлы классификации для этого проекта.

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)

Возвращает информацию по всем полям. Параметр идентификатор/имя проекта является необязательным.

getQueries(string, QueryExpand, number, boolean)

Получает корневые запросы и их дочерние элементы

getQueriesBatch(QueryBatchGetRequest, string)

Получает список запросов по ids (Максимум 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)

Получает шаблон с указанным 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)

Возвращает следующее состояние для заданных идентификаторов рабочих элементов.

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

ТОЛЬКО ВНУТРЕННЕЕ: Используется для поставщиков цветов и иконок. Получение цвета типа wit для нескольких проектов

getWorkItemTypeColors(string[])

ТОЛЬКО ВНУТРЕННЕЕ: Будет использоваться для работы с моей учетной записью. Получение цвета типа wit для нескольких проектов

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)

Параметры

Сведения о свойстве

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

Целевой проект Area Path

Возвращаемое значение

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

Путь к узлу классификации.

Возвращаемое значение

createQuery(QueryHierarchyItem, string, string, boolean)

Создает запрос или перемещает его.

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

Параметры

postedQuery
QueryHierarchyItem

Запрос для создания.

project

string

Идентификатор проекта или имя проекта

query

string

Родительский идентификатор или путь, по которому должен быть создан запрос.

validateWiqlOnly

boolean

Если вы хотите только проверить свой запрос WIQL без фактического его создания, установите для него значение true. По умолчанию — false.

Возвращаемое значение

createTemplate(WorkItemTemplate, string, string)

Создает шаблон

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

Параметры

template
WorkItemTemplate

Содержимое шаблона

project

string

Идентификатор проекта или имя проекта

team

string

Идентификатор команды или название команды

Возвращаемое значение

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 Patch, представляющий рабочий элемент

project

string

Идентификатор проекта или имя проекта

type

string

Тип рабочего элемента создаваемого рабочего элемента

validateOnly

boolean

Укажите, хотите ли вы только проверить изменения без сохранения рабочего элемента

bypassRules

boolean

Не применяйте правила типов рабочих элементов в этом обновлении

suppressNotifications

boolean

Не отправляйте никаких уведомлений об этом изменении

expand
WorkItemExpand

Параметры развертывания для атрибутов рабочих элементов. Возможные варианты: { Нет, Отношения, Поля, Ссылки, Все }.

Возвращаемое значение

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

Идентификатор целевого узла классификации для реклассификации.

Возвращаемое значение

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

Идентификатор команды или название команды

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

Возвращаемое значение

getAccountMyWorkData(QueryOption)

ТОЛЬКО ВНУТРЕННИЙ: ИСПОЛЬЗУЕТСЯ УЧЕТНОЙ ЗАПИСЬЮ СТРАНИЦА МОЯ РАБОТА. При этом возвращаются сведения о рабочих элементах Doing, Done, Follows и рабочих элементах действия.

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

Параметры

queryOption
QueryOption

Возвращаемое значение

getAttachmentContent(string, string, string, boolean)

Загружает вложение.

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

Параметры

id

string

Идентификатор вложения

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

Идентификатор вложения

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

Глубина детей для извлечения.

Возвращаемое значение

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

Получает корневые узлы классификации или список узлов классификации для заданного списка идентификаторов узлов для данного проекта. Если параметр ids указан, вы получите список узлов классификации для этих идентификаторов. В противном случае вы получите корневые узлы классификации для этого проекта.

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

Параметры

project

string

Идентификатор проекта или имя проекта

ids

number[]

Через запятую целочисленные классификационные узлы ids. Это не обязательно, если вы хотите корневые узлы.

depth

number

Глубина детей для извлечения.

errorPolicy
ClassificationNodesErrorPolicy

Флаг для обработки ошибок при получении некоторых узлов. Возможные варианты: Fail и Omit.

Возвращаемое значение

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

Идентификатор проекта или имя проекта

Возвращаемое значение

getDeletedWorkItemShallowReferences(string)

Получает список идентификаторов и URL-адресов удаленных рабочих элементов в корзине.

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

Параметры

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

getField(string, string)

Получает информацию по конкретному полю.

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

Параметры

fieldNameOrRefName

string

Простое имя поля или ссылочное имя

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

Возвращает информацию по всем полям. Параметр идентификатор/имя проекта является необязательным.

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)

Получает список запросов по ids (Максимум 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

ID или путь к запросу.

expand
QueryExpand

Включите в результаты строку запроса (wiql), предложения, столбцы результатов запроса и параметры сортировки.

depth

number

В папке запросов возвращаем дочерние запросы и папки на эту глубину.

includeDeleted

boolean

Включение удаленных запросов и папок

useIsoDateFormat

boolean

Предложения запроса DateTime будут отформатированы с использованием формата, соответствующего стандарту ISO 8601

Возвращаемое значение

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

Идентификатор команды или название команды

timePrecision

boolean

Следует ли использовать точность времени.

top

number

Максимальное количество возвращаемых результатов.

Возвращаемое значение

Promise<number>

getRecentActivityData()

Получает последние действия рабочих элементов

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Возвращаемое значение

getRecentMentions()

ТОЛЬКО ВНУТРЕННИЙ: ИСПОЛЬЗУЕТСЯ УЧЕТНОЙ ЗАПИСЬЮ СТРАНИЦА МОЯ РАБОТА.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Возвращаемое значение

getRelationType(string)

Получает определение типа отношения рабочего элемента.

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

Параметры

relation

string

Имя отношения

Возвращаемое значение

getRelationTypes()

Получает типы отношений рабочих элементов.

function getRelationTypes(): 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'.

Возвращаемое значение

getRevision(number, number, string, WorkItemExpand)

Возвращает полностью гидратированный рабочий элемент для запрошенной ревизии

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

Параметры

id

number

revisionNumber

number

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

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

Возвращаемое значение

Promise<WorkItem[]>

getRootNodes(string, number)

Получает корневые узлы классификации в рамках проекта.

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

Параметры

project

string

Идентификатор проекта или имя проекта

depth

number

Глубина детей для извлечения.

Возвращаемое значение

getTemplate(string, string, string)

Получает шаблон с указанным id

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

Параметры

project

string

Идентификатор проекта или имя проекта

team

string

Идентификатор команды или название команды

templateId

string

Идентификатор шаблона

Возвращаемое значение

Promise<WorkItemTemplate>

getTemplates(string, string, string)

Получает шаблон

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

Параметры

project

string

Идентификатор проекта или имя проекта

team

string

Идентификатор команды или название команды

workitemtypename

string

Необязательно, При указании возвращает шаблоны для заданного типа Work item.

Возвращаемое значение

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

Параметры развертывания для атрибутов рабочих элементов. Возможные варианты: { Нет, Отношения, Поля, Ссылки, Все }.

Возвращаемое значение

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

Возможные действия. В настоящее время поддерживает только регистрацию

Возвращаемое значение

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 удостоверений личности).

project

string

Идентификатор проекта или имя проекта

fields

string[]

Список запрашиваемых полей, разделенных запятыми

asOf

Date

AsOf UTC строка даты и времени

expand
WorkItemExpand

Параметры развертывания для атрибутов рабочих элементов. Возможные варианты: { Нет, Отношения, Поля, Ссылки, Все }.

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

Возвращаемое значение

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

Параметры развертывания для атрибутов рабочих элементов. Возможные варианты: { Нет, Отношения, Поля, Ссылки, Все }.

Возвращаемое значение

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

Идентификатор проекта или имя проекта

Возвращаемое значение

getWorkItemTypeCategory(string, string)

Получение определенного типа рабочего элемента категории по имени.

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

Параметры

project

string

Идентификатор проекта или имя проекта

category

string

Название категории

Возвращаемое значение

getWorkItemTypeColorAndIcons(string[])

ТОЛЬКО ВНУТРЕННЕЕ: Используется для поставщиков цветов и иконок. Получение цвета типа wit для нескольких проектов

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

Параметры

projectNames

string[]

Возвращаемое значение

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

getWorkItemTypeColors(string[])

ТОЛЬКО ВНУТРЕННЕЕ: Будет использоваться для работы с моей учетной записью. Получение цвета типа wit для нескольких проектов

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: чтобы пропустить эти свойства.

Возвращаемое значение

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: чтобы пропустить эти свойства.

Возвращаемое значение

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

Идентификатор команды или название команды

timePrecision

boolean

Следует ли использовать точность времени.

top

number

Максимальное количество возвращаемых результатов.

Возвращаемое значение

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

Идентификатор команды или название команды

timePrecision

boolean

Следует ли использовать точность времени.

top

number

Максимальное количество возвращаемых результатов.

Возвращаемое значение

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

Запрашивает рабочие элементы, связанные с заданным списком URI артефактов.

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

Параметры

artifactUriQuery
ArtifactUriQuery

Определяет список универсальных кодов ресурса ресурса (URI) артефакта для запроса рабочих элементов.

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

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

Максимальное количество результатов, возвращаемых в этом пакете

Возвращаемое значение

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'.

Возвращаемое значение

replaceTemplate(WorkItemTemplate, string, string, string)

Замена содержимого шаблона

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

Параметры

templateContent
WorkItemTemplate

Содержимое шаблона для замены на

project

string

Идентификатор проекта или имя проекта

team

string

Идентификатор команды или название команды

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

Включение удаленных запросов и папок

Возвращаемое значение

sendMail(SendMailBody, string)

Метод RESTful для отправки почты по выбранным/запрошенным рабочим элементам.

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

Параметры

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

Путь к узлу классификации.

Возвращаемое значение

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

Восстановите дочерние элементы этой папки. Важно отметить, что это не приведет к возвращению изменений разрешений, которые ранее применялись к потомкам.

Возвращаемое значение

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 Patch, представляющий обновление

id

number

Идентификатор рабочего элемента для обновления

project

string

Идентификатор проекта или имя проекта

validateOnly

boolean

Укажите, хотите ли вы только проверить изменения без сохранения рабочего элемента

bypassRules

boolean

Не применяйте правила типов рабочих элементов в этом обновлении

suppressNotifications

boolean

Не отправляйте никаких уведомлений об этом изменении

expand
WorkItemExpand

Параметры развертывания для атрибутов рабочих элементов. Возможные варианты: { Нет, Отношения, Поля, Ссылки, Все }.

Возвращаемое значение

Promise<WorkItem>

updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)

Добавление/обновление типа рабочего элемента

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

Параметры

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение