WorkItemTrackingRestClient class

Ссылка

Пакет:: azure-devops-extension-api

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

Extends: RestClientBase

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

WorkItemTrackingRestClient(IVssRestClientOptions)

Свойства

RESOURCE_AREA_ID

Методы

createAttachment(any, string, string, string, string)	Отправляет вложение.
createField(WorkItemField, string)	Создайте новое поле.
createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Создайте новый или обновите существующий узел классификации.
createQuery(QueryHierarchyItem, string, string, boolean)	Создает запрос или перемещает запрос.
createTemplate(WorkItemTemplate, string, string)	Создание шаблона
createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)	Создает один рабочий элемент.
deleteClassificationNode(string, TreeStructureGroup, string, number)	Удаление существующего узла классификации.
deleteField(string, string)	Удаляет поле . Сведения об отмене удаления поданного см. в разделе API обновления поля.
deleteQuery(string, string)	Удаление запроса или папки. При этом удаляются все изменения разрешений на удаленный запрос или папку, а также все его потомки, если это папка. Важно отметить, что удаленные изменения разрешений невозможно восстановить после удаления запроса или папки.
deleteTemplate(string, string, string)	Удаляет шаблон с заданным идентификатором.
deleteWorkItem(number, string, boolean)	Удаляет указанный рабочий элемент и отправляет его в корзину, чтобы при необходимости его можно было восстановить обратно. При необходимости, если параметру destroy присвоено значение true, рабочий элемент будет уничтожен безвозвратно. ПРЕДУПРЕЖДЕНИЕ. Если параметр destroy имеет значение true, рабочие элементы, удаленные этой командой, не будут отправляться в корзину, а восстановить их после удаления невозможно. Этот параметр не рекомендуется использовать. В этом случае используйте этот параметр с особой осторожностью.
destroyWorkItem(number, string)	Окончательно удаляет указанный рабочий элемент из корзины. Это действие нельзя отменить.
exportWorkItemTypeDefinition(string, string, boolean)	Экспорт типа рабочего элемента
getAccountMyWorkData(QueryOption)	ТОЛЬКО ВНУТРЕННЯЯ: ИСПОЛЬЗУЕТСЯ УЧЕТНОЙ ЗАПИСЬЮ МОЯ РАБОЧАЯ СТРАНИЦА. При этом возвращаются сведения о рабочих элементах "Выполнение", "Выполнено", "После" и "Действия".
getAttachmentContent(string, string, string, boolean)	Скачивает вложение.
getAttachmentZip(string, string, string, boolean)	Скачивает вложение.
getClassificationNode(string, TreeStructureGroup, string, number)	Возвращает узел классификации для заданного пути к узлу.
getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)	Возвращает корневые узлы классификации или список узлов классификации для заданного списка идентификаторов узлов для заданного проекта. Если указан параметр 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)	Возвращает сведения для всех полей. Параметр id/name проекта необязателен.
getQueries(string, QueryExpand, number, boolean)	Возвращает корневые запросы и их дочерние элементы
getQueriesBatch(QueryBatchGetRequest, string)	Возвращает список запросов по идентификаторам (максимум 1000)
getQuery(string, string, QueryExpand, number, boolean, boolean)	Извлекает отдельный запрос и его дочерние элементы.
getQueryResultCount(string, string, string, boolean, number)	Возвращает результаты запроса, заданные идентификатором запроса.
getRecentActivityData()	Возвращает недавние действия рабочих элементов
getRecentMentions()	ТОЛЬКО ВНУТРЕННЯЯ: ИСПОЛЬЗУЕТСЯ УЧЕТНОЙ ЗАПИСЬЮ МОЯ РАБОЧАЯ СТРАНИЦА.
getRelationType(string)	Возвращает определение типа отношения рабочего элемента.
getRelationTypes()	Возвращает типы отношений рабочих элементов.
getReportingLinksByLinkType(string, string[], string[], string, Date)	Получение пакета ссылок на рабочие элементы
getRevision(number, number, string, WorkItemExpand)	Возвращает полностью восстановленный рабочий элемент для запрошенной редакции.
getRevisions(number, string, number, number, WorkItemExpand)	Возвращает список полностью гидратированных исправлений рабочих элементов, перестраивается на страницы.
getRootNodes(string, number)	Возвращает корневые узлы классификации в проекте.
getTemplate(string, string, string)	Возвращает шаблон с указанным идентификатором.
getTemplates(string, string, string)	Возвращает шаблон
getUpdate(number, number, string)	Возвращает одно обновление для рабочего элемента
getUpdates(number, string, number, number)	Возвращает разницу между редакциями рабочих элементов
getWorkArtifactLinkTypes()	Получение списка типов ссылок на исходящие артефакты для отслеживания рабочих элементов.
getWorkItem(number, string, string[], Date, WorkItemExpand)	Возвращает один рабочий элемент.
getWorkItemIconJson(string, string, number)	Получение значка рабочего элемента с понятным именем и цветом значка.
getWorkItemIcons()	Получение списка всех значков рабочих элементов.
getWorkItemIconSvg(string, string, number)	Получение значка рабочего элемента с понятным именем и цветом значка.
getWorkItemIconXaml(string, string, number)	Получение значка рабочего элемента с понятным именем и цветом значка.
getWorkItemNextStatesOnCheckinAction(number[], string)	Возвращает следующее состояние для заданных идентификаторов рабочих элементов.
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)	Возвращает список рабочих элементов (максимум 200)
getWorkItemsBatch(WorkItemBatchGetRequest, string)	Возвращает рабочие элементы для списка идентификаторов рабочих элементов (максимум 200)
getWorkItemStateColors(string[])	INTERNAL ONLY: он будет использоваться для работы с моей учетной записью. Получение цвета состояния типа рабочего элемента для нескольких проектов
getWorkItemTemplate(string, string, string, Date, WorkItemExpand)	Возвращает один рабочий элемент из шаблона.
getWorkItemType(string, string)	Возвращает определение типа рабочего элемента.
getWorkItemTypeCategories(string)	Получение всех категорий типов рабочих элементов.
getWorkItemTypeCategory(string, string)	Получение определенной категории типа рабочего элемента по имени.
getWorkItemTypeColorAndIcons(string[])	ТОЛЬКО ВНУТРЕННЕЕ: используется для поставщиков цветов и значков. Получение цвета типа остроумия для нескольких проектов
getWorkItemTypeColors(string[])	ТОЛЬКО ВНУТРЕННЕЕ. Он будет использоваться для работы с моей учетной записью. Получение цвета типа остроумия для нескольких проектов
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)	Получение списка полей для типа рабочего элемента с подробными ссылками.
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)	Получение поля для типа рабочего элемента с подробными ссылками.
getWorkItemTypes(string)	Возвращает список типов рабочих элементов
getWorkItemTypeStates(string, string)	Возвращает имена состояний и цвета для типа рабочего элемента.
queryById(string, string, string, boolean, number)	Возвращает результаты запроса по заданному идентификатору запроса.
queryByWiql(Wiql, string, string, boolean, number)	Возвращает результаты запроса с учетом его WIQL.
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)	Запросы рабочих элементов, связанных с заданным списком URI артефакта.
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)	Получение пакета исправлений рабочих элементов с возможностью включения удаленных элементов
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)	Получение пакета исправлений рабочих элементов. Этот запрос может использоваться, если список полей достаточно велик, чтобы он мог выполнять URL-адрес сверх предельной длины.
replaceTemplate(WorkItemTemplate, string, string, string)	Замена содержимого шаблона
restoreWorkItem(WorkItemDeleteUpdate, number, string)	Восстанавливает удаленный рабочий элемент из корзины.
searchQueries(string, string, number, QueryExpand, boolean)	Выполняет поиск по всем запросам, к которые у пользователя есть доступ в текущем проекте
sendMail(SendMailBody, string)	Метод RESTful для отправки почты для выбранных или запрошенных рабочих элементов.
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	Обновление существующего узла классификации.
updateField(UpdateWorkItemField, string, string)	Обновление поля.
updateQuery(QueryHierarchyItem, string, string, boolean)	Обновление запроса или папки. Это позволяет обновлять, переименовывать и перемещать запросы и папки.
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)	Обновления одного рабочего элемента.
updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)	Добавление или обновление типа рабочего элемента

Сведения о конструкторе

WorkItemTrackingRestClient(IVssRestClientOptions)

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

Параметры

options: IVssRestClientOptions

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

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Значение свойства

string

Сведения о методе

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

Отправляет вложение.

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

Параметры

content: any

Содержимое для отправки

project: string

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

fileName: string

Имя файла

uploadType: string

Тип отправки вложений: простой или фрагментованный

areaPath: string

Путь к области целевого проекта

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

Promise<AttachmentReference>

createField(WorkItemField, string)

Создайте новое поле.

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

Параметры

workItemField: WorkItemField

Новое определение поля

project: string

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

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

Promise<WorkItemField>

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Создайте новый или обновите существующий узел классификации.

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

Параметры

postedNode: WorkItemClassificationNode

Узел для создания или обновления.

project: string

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

structureGroup: TreeStructureGroup

Группа структуры узла классификации, области или итерации.

path: string

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

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

Promise<WorkItemClassificationNode>

createQuery(QueryHierarchyItem, string, string, boolean)

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

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

Параметры

postedQuery: QueryHierarchyItem

Создаваемый запрос.

project: string

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

query: string

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

validateWiqlOnly: boolean

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

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

Promise<QueryHierarchyItem>

createTemplate(WorkItemTemplate, string, string)

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

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

Параметры

template: WorkItemTemplate

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

project: string

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

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

Параметры развертывания для атрибутов рабочих элементов. Возможные варианты: { None, Relations, Fields, Links, All }.

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

Promise<WorkItem>

deleteClassificationNode(string, TreeStructureGroup, string, number)

Удаление существующего узла классификации.

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

Параметры

project: string

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

structureGroup: TreeStructureGroup

Группа структуры узла классификации, области или итерации.

path: string

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

reclassifyId: number

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

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

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)

Удаляет шаблон с заданным идентификатором.

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

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

Promise<WorkItemTypeTemplate>

getAccountMyWorkData(QueryOption)

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

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

Параметры

queryOption: QueryOption

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

Promise<AccountMyWorkResult>

getAttachmentContent(string, string, string, boolean)

Скачивает вложение.

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

Параметры

id: string

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

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

Глубина извлекаемых дочерних элементов.

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

Promise<WorkItemClassificationNode>

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

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

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

Параметры

project: string

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

ids: number[]

Идентификаторы узлов классификации с разделителями-запятыми. Это необязательно, если вам нужны корневые узлы.

depth: number

Глубина извлекаемых дочерних элементов.

errorPolicy: ClassificationNodesErrorPolicy

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

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

Promise<WorkItemClassificationNode[]>

getComment(number, number, string)

Возвращает комментарий для рабочего элемента в указанной редакции.

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

Параметры

id: number

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

revision: number

Редакция, для которой необходимо получить комментарий

project: string

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

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

Promise<WorkItemComment>

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

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

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

Параметры

id: number

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

project: string

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

fromRevision: number

Редакция, из которой требуется получить комментарии (по умолчанию — 1)

top: number

Количество возвращаемых комментариев (по умолчанию — 200)

order: CommentSortOrder

По возрастанию или убыванию по идентификатору редакции (по умолчанию — по возрастанию)

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

Promise<WorkItemComments>

getDeletedWorkItem(number, string)

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

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

Параметры

id: number

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

project: string

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

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

Promise<WorkItemDelete>

getDeletedWorkItems(number[], string)

Возвращает рабочие элементы из корзины, идентификаторы которых указаны в параметрах

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

Параметры

ids: number[]

Разделенный запятыми список идентификаторов удаленных рабочих элементов, которые должны быть возвращены

project: string

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

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

Promise<WorkItemDeleteReference[]>

getDeletedWorkItemShallowReferences(string)

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

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

Параметры

project: string

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

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

Promise<WorkItemDeleteShallowReference[]>

getField(string, string)

Получает сведения о конкретном поле.

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

Параметры

fieldNameOrRefName: string

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

project: string

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

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

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

Возвращает сведения для всех полей. Параметр id/name проекта необязателен.

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)

Возвращает список запросов по идентификаторам (максимум 1000)

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

Параметры

queryGetRequest: QueryBatchGetRequest

project: string

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

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

Promise<QueryHierarchyItem[]>

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

Извлекает отдельный запрос и его дочерние элементы.

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

Параметры

project: string

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

query: string

Идентификатор или путь запроса.

expand: QueryExpand

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

depth: number

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

includeDeleted: boolean

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

useIsoDateFormat: boolean

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

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

Promise<QueryHierarchyItem>

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

Возвращает результаты запроса, заданные идентификатором запроса.

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

Параметры

id: string

Идентификатор запроса.

project: string

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

team: string

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

timePrecision: boolean

Указывает, следует ли использовать точность времени.

top: number

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

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

Promise<number>

getRecentActivityData()

Возвращает недавние действия рабочих элементов

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

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

Promise<AccountRecentActivityWorkItemModel2[]>

getRecentMentions()

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

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

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

Promise<AccountRecentMentionWorkItemModel[]>

getRelationType(string)

Возвращает определение типа отношения рабочего элемента.

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

Параметры

relation: string

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

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

Promise<WorkItemRelationType>

getRelationTypes()

Возвращает типы отношений рабочих элементов.

function getRelationTypes(): Promise<WorkItemRelationType[]>

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

Promise<WorkItemRelationType[]>

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

Получение пакета ссылок на рабочие элементы

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

Параметры

project: string

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

linkTypes: string[]

Список типов для фильтрации результатов по определенным типам ссылок. Пропустите этот параметр, чтобы получить ссылки на рабочие элементы всех типов ссылок.

types: string[]

Список типов для фильтрации результатов по определенным типам рабочих элементов. Пропустите этот параметр, чтобы получить ссылки на рабочие элементы всех типов рабочих элементов.

continuationToken: string

Указывает элемент continuationToken для запуска пакета. Пропустите этот параметр, чтобы получить первый пакет ссылок.

startDateTime: Date

Дата и время для использования в качестве отправной точки для изменения связи. Будут возвращены только изменения ссылок, произошедшие после этой даты и времени. Не может использоваться в сочетании с параметром "водяной знак".

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

Promise<ReportingWorkItemLinksBatch>

getRevision(number, number, string, WorkItemExpand)

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

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

Параметры

id: number

revisionNumber: number

project: string

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

expand: WorkItemExpand

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

Promise<WorkItem>

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

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

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

Параметры

id: number

project: string

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

top: number

skip: number

expand: WorkItemExpand

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

Promise<WorkItem[]>

getRootNodes(string, number)

Возвращает корневые узлы классификации в проекте.

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

Параметры

project: string

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

depth: number

Глубина извлекаемых дочерних элементов.

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

Promise<WorkItemClassificationNode[]>

getTemplate(string, string, string)

Возвращает шаблон с указанным идентификатором.

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

Параметры

project: string

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

team: string

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

templateId: string

ИД шаблона

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

Promise<WorkItemTemplate>

getTemplates(string, string, string)

Возвращает шаблон

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

Параметры

project: string

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

team: string

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

workitemtypename: string

Необязательный параметр при указании возвращает шаблоны для заданного типа рабочего элемента.

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

Promise<WorkItemTemplateReference[]>

getUpdate(number, number, string)

Возвращает одно обновление для рабочего элемента

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

Параметры

id: number

updateNumber: number

project: string

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

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

Promise<WorkItemUpdate>

getUpdates(number, string, number, number)

Возвращает разницу между редакциями рабочих элементов

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

Параметры

id: number

project: string

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

top: number

skip: number

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

Promise<WorkItemUpdate[]>

getWorkArtifactLinkTypes()

Получение списка типов ссылок на исходящие артефакты для отслеживания рабочих элементов.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

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

Promise<WorkArtifactLink[]>

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

Возвращает один рабочий элемент.

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

Параметры

id: number

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

project: string

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

fields: string[]

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

asOf: Date

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

expand: WorkItemExpand

Параметры развертывания для атрибутов рабочих элементов. Возможные варианты: { None, Relations, Fields, Links, All }.

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

Promise<WorkItem>

getWorkItemIconJson(string, string, number)

Получение значка рабочего элемента с понятным именем и цветом значка.

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

Параметры

icon: string

Имя значка

color: string

6-значный шестнадцатеричный цвет значка

v: number

Версия значка (используется только для недействительности кэша)

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

Promise<WorkItemIcon>

getWorkItemIcons()

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

function getWorkItemIcons(): Promise<WorkItemIcon[]>

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

Promise<WorkItemIcon[]>

getWorkItemIconSvg(string, string, number)

Получение значка рабочего элемента с понятным именем и цветом значка.

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

Параметры

icon: string

Имя значка

color: string

6-значный шестнадцатеричный цвет значка

v: number

Версия значка (используется только для недействительности кэша)

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

Promise<any>

getWorkItemIconXaml(string, string, number)

Получение значка рабочего элемента с понятным именем и цветом значка.

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

Параметры

icon: string

Имя значка

color: string

6-значный шестнадцатеричный цвет значка

v: number

Версия значка (используется только для недействительности кэша)

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

Promise<any>

getWorkItemNextStatesOnCheckinAction(number[], string)

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

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

Параметры

ids: number[]

список идентификаторов рабочих элементов

action: string

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

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

Promise<WorkItemNextStateOnTransition[]>

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

Возвращает список рабочих элементов (максимум 200)

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

Параметры

ids: number[]

Разделенный запятыми список запрошенных идентификаторов рабочих элементов. (Допускается не более 200 идентификаторов).

project: string

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

fields: string[]

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

asOf: Date

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

expand: WorkItemExpand

Параметры развертывания для атрибутов рабочих элементов. Возможные варианты: { None, Relations, Fields, Links, All }.

errorPolicy: WorkItemErrorPolicy

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

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

Promise<WorkItem[]>

getWorkItemsBatch(WorkItemBatchGetRequest, string)

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

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

Параметры

workItemGetRequest: WorkItemBatchGetRequest

project: string

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

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

Promise<WorkItem[]>

getWorkItemStateColors(string[])

INTERNAL ONLY: он будет использоваться для работы с моей учетной записью. Получение цвета состояния типа рабочего элемента для нескольких проектов

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

Параметры

projectNames: string[]

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

Promise<ProjectWorkItemStateColors[]>

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

Возвращает один рабочий элемент из шаблона.

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

Параметры

project: string

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

type: string

Имя типа рабочего элемента

fields: string

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

asOf: Date

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

expand: WorkItemExpand

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

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

Promise<WorkItem>

getWorkItemType(string, string)

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

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

Параметры

project: string

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

type: string

Имя типа рабочего элемента

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

Promise<WorkItemType>

getWorkItemTypeCategories(string)

Получение всех категорий типов рабочих элементов.

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

Параметры

project: string

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

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

Promise<WorkItemTypeCategory[]>

getWorkItemTypeCategory(string, string)

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

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

Параметры

project: string

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

category: string

Имя категории

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

Promise<WorkItemTypeCategory>

getWorkItemTypeColorAndIcons(string[])

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

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

Параметры

projectNames: string[]

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

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

getWorkItemTypeColors(string[])

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

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

Параметры

projectNames: string[]

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

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

getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)

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

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

Параметры

project: string

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

type: string

Тип рабочего элемента.

expand: WorkItemTypeFieldsExpandLevel

Разверните уровень ответа API. Свойства: для включения разрешенных значений, значений по умолчанию, isRequired и т. д. в составе ответа; Нет: чтобы пропустить эти свойства.

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

Promise<WorkItemTypeFieldWithReferences[]>

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

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

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

Параметры

project: string

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

type: string

Тип рабочего элемента.

field: string

expand: WorkItemTypeFieldsExpandLevel

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

Promise<WorkItemTypeFieldWithReferences>

getWorkItemTypes(string)

Возвращает список типов рабочих элементов

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

Параметры

project: string

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

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

Promise<WorkItemType[]>

getWorkItemTypeStates(string, string)

Возвращает имена состояний и цвета для типа рабочего элемента.

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

Параметры

project: string

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

type: string

Имя состояния

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

Promise<WorkItemStateColor[]>

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

Возвращает результаты запроса по заданному идентификатору запроса.

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

Параметры

id: string

Идентификатор запроса.

project: string

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

team: string

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

timePrecision: boolean

Указывает, следует ли использовать точность времени.

top: number

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

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

Promise<WorkItemQueryResult>

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

Возвращает результаты запроса с учетом его WIQL.

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

Параметры

wiql: Wiql

Запрос, содержащий WIQL.

project: string

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

team: string

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

timePrecision: boolean

Указывает, следует ли использовать точность времени.

top: number

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

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

Promise<WorkItemQueryResult>

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

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

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

Параметры

artifactUriQuery: ArtifactUriQuery

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

project: string

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

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

Promise<ArtifactUriQueryResult>

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

Получение пакета исправлений рабочих элементов с возможностью включения удаленных элементов

function readReportingRevisionsGet(project?: string, fields?: string[], types?: string[], continuationToken?: string, startDateTime?: Date, includeIdentityRef?: boolean, includeDeleted?: boolean, includeTagRef?: boolean, includeLatestOnly?: boolean, expand?: ReportingRevisionsExpand, includeDiscussionChangesOnly?: boolean, maxPageSize?: number): Promise<ReportingWorkItemRevisionsBatch>

Параметры

project: string

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

fields: string[]

Список полей, возвращаемых в редакциях рабочих элементов. Опустите этот параметр, чтобы получить все поля, доступные для отчета.

types: string[]

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

continuationToken: string

Указывает водяной знак для запуска пакета. Опустите этот параметр, чтобы получить первый пакет исправлений.

startDateTime: Date

Дата и время, используемые в качестве отправной точки для исправлений, все изменения будут происходить после этой даты и времени. Не может использоваться в сочетании с параметром watermark.

includeIdentityRef: boolean

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

includeDeleted: boolean

Укажите, следует ли возвращать удаленный элемент.

includeTagRef: boolean

Укажите, следует ли возвращать объекты тега для поля System.Tags.

includeLatestOnly: boolean

Возвращает только последние редакции рабочих элементов, пропуская все исторические редакции.

expand: ReportingRevisionsExpand

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

includeDiscussionChangesOnly: boolean

Возвращает только те редакции рабочих элементов, в которых было изменено только поле журнала.

maxPageSize: number

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

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

Promise<ReportingWorkItemRevisionsBatch>

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

Получение пакета исправлений рабочих элементов. Этот запрос может использоваться, если список полей достаточно велик, чтобы он мог выполнять URL-адрес сверх предельной длины.

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

Параметры

filter: ReportingWorkItemRevisionsFilter

Объект, содержащий параметры запроса: фильтр полей, фильтр типов, формат удостоверения

project: string

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

continuationToken: string

Указывает водяной знак для запуска пакета. Опустите этот параметр, чтобы получить первый пакет исправлений.

startDateTime: Date

expand: ReportingRevisionsExpand

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

Promise<ReportingWorkItemRevisionsBatch>

replaceTemplate(WorkItemTemplate, string, string, string)

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

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

Параметры

templateContent: WorkItemTemplate

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

project: string

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

team: string

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

templateId: string

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

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

Promise<WorkItemTemplate>

restoreWorkItem(WorkItemDeleteUpdate, number, string)

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

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

Параметры

payload: WorkItemDeleteUpdate

Paylod с инструкциями по обновлению флага IsDeleted до false

id: number

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

project: string

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

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

Promise<WorkItemDelete>

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

Выполняет поиск по всем запросам, к которые у пользователя есть доступ в текущем проекте

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

Параметры

project: string

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

filter: string

Текст для фильтрации запросов.

top: number

Количество возвращаемых запросов (по умолчанию — 50, а максимальное — 200).

expand: QueryExpand

includeDeleted: boolean

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

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

Promise<QueryHierarchyItemsResult>

sendMail(SendMailBody, string)

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

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

Параметры

body: SendMailBody

project: string

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

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

Promise<void>

updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Обновление существующего узла классификации.

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

Параметры

postedNode: WorkItemClassificationNode

Узел для создания или обновления.

project: string

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

structureGroup: TreeStructureGroup

Группа структуры узла классификации, области или итерации.

path: string

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

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

Promise<WorkItemClassificationNode>

updateField(UpdateWorkItemField, string, string)

Обновление поля.

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

Параметры

payload: UpdateWorkItemField

Полезные данные содержат требуемое значение свойств поля.

fieldNameOrRefName: string

Имя или ссылка на обновляемое поле

project: string

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

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

Promise<WorkItemField>

updateQuery(QueryHierarchyItem, string, string, boolean)

Обновление запроса или папки. Это позволяет обновлять, переименовывать и перемещать запросы и папки.

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

Параметры

queryUpdate: QueryHierarchyItem

Запрос для обновления.

project: string

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

query: string

Идентификатор или путь для обновляемого запроса.

undeleteDescendants: boolean

Отмените удаление дочерних элементов этой папки. Важно отметить, что это не приведет к возврату изменений разрешений, которые ранее были применены к потомкам.

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

Promise<QueryHierarchyItem>

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

Обновления одного рабочего элемента.

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

Параметры

document: JsonPatchDocument

Документ json patch, представляющий обновление

id: number

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

project: string

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

validateOnly: boolean

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

bypassRules: boolean

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

suppressNotifications: boolean

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

expand: WorkItemExpand

Параметры развертывания для атрибутов рабочих элементов. Возможные варианты: { None, Relations, Fields, Links, All }.

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

Promise<WorkItem>

updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)

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

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

Параметры

updateModel: WorkItemTypeTemplateUpdateModel

project: string

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

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

Promise<ProvisioningResult>

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

WorkItemTrackingRestClient class

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

Свойства

Методы

Сведения о конструкторе

WorkItemTrackingRestClient(IVssRestClientOptions)

Параметры

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

RESOURCE_AREA_ID

Значение свойства

Сведения о методе

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

Параметры

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

createField(WorkItemField, string)

Параметры

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

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Параметры

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

createQuery(QueryHierarchyItem, string, string, boolean)

Параметры

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

createTemplate(WorkItemTemplate, string, string)

Параметры

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

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

Параметры

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

deleteClassificationNode(string, TreeStructureGroup, string, number)

Параметры

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

deleteField(string, string)

Параметры

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

deleteQuery(string, string)

Параметры

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

deleteTemplate(string, string, string)

Параметры

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

deleteWorkItem(number, string, boolean)

Параметры

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

destroyWorkItem(number, string)

Параметры

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

exportWorkItemTypeDefinition(string, string, boolean)

Параметры

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

getAccountMyWorkData(QueryOption)

Параметры

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

getAttachmentContent(string, string, string, boolean)

Параметры

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

getAttachmentZip(string, string, string, boolean)

Параметры

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

getClassificationNode(string, TreeStructureGroup, string, number)

Параметры

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

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

Параметры

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

getComment(number, number, string)

Параметры

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

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

Параметры

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

getDeletedWorkItem(number, string)

Параметры

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

getDeletedWorkItems(number[], string)

Параметры

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

getDeletedWorkItemShallowReferences(string)

Параметры