WorkItemTrackingProcessRestClient class

Ссылка

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

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

Extends: RestClientBase

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

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

Свойства

RESOURCE_AREA_ID

Методы

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Добавляет поведение к типу рабочего элемента процесса.
addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)	Добавляет поле к типу рабочего элемента.
addGroup(Group, string, string, string, string)	Добавляет группу в форму рабочего элемента.
addPage(Page, string, string)	Добавляет страницу в форму рабочего элемента.
addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)	Добавляет правило к типу рабочего элемента в процессе.
createControlInGroup(Control, string, string, string)	Создает элемент управления в группе.
createList(PickList)	Создает список выбора.
createNewProcess(CreateProcessModel)	Создает процесс.
createProcessBehavior(ProcessBehaviorCreateRequest, string)	Создает единое поведение в заданном процессе.
createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)	Создает тип рабочего элемента в процессе.
createStateDefinition(WorkItemStateInputModel, string, string)	Создает определение состояния в типе рабочего элемента процесса.
deleteList(string)	Удаляет список выбора.
deleteProcessBehavior(string, string)	Удаляет поведение в процессе.
deleteProcessById(string)	Удаляет процесс с определенным идентификатором.
deleteProcessWorkItemType(string, string)	Удаляет тип рабочего элемента в процессе.
deleteProcessWorkItemTypeRule(string, string, string)	Удаляет правило из типа рабочего элемента в процессе.
deleteStateDefinition(string, string, string)	Удаляет определение состояния в типе рабочего элемента процесса.
deleteSystemControl(string, string, string)	Удаляет изменение системного элемента управления в форме рабочего элемента.
editProcess(UpdateProcessModel, string)	Изменение процесса с определенным идентификатором.
getAllWorkItemTypeFields(string, string)	Возвращает список всех полей в типе рабочего элемента.
getBehaviorForWorkItemType(string, string, string)	Возвращает поведение для типа рабочего элемента процесса.
getBehaviorsForWorkItemType(string, string)	Возвращает список всех поведений для типа рабочего элемента процесса.
getFormLayout(string, string)	Возвращает макет формы.
getList(string)	Возвращает список выбора.
getListOfProcesses(GetProcessExpandLevel)	Получение списка всех процессов, включая системные и унаследованные.
getListsMetadata()	Возвращает метаданные списка выбора.
getProcessBehavior(string, string, GetBehaviorsExpand)	Возвращает поведение процесса.
getProcessBehaviors(string, GetBehaviorsExpand)	Возвращает список всех поведений в процессе.
getProcessByItsId(string, GetProcessExpandLevel)	Получение одного процесса с указанным идентификатором.
getProcessWorkItemType(string, string, GetWorkItemTypeExpand)	Возвращает один тип рабочего элемента в процессе.
getProcessWorkItemTypeRule(string, string, string)	Возвращает одно правило в типе рабочего элемента процесса.
getProcessWorkItemTypeRules(string, string)	Возвращает список всех правил в типе рабочего элемента процесса.
getProcessWorkItemTypes(string, GetWorkItemTypeExpand)	Возвращает список всех типов рабочих элементов в процессе.
getStateDefinition(string, string, string)	Возвращает одно определение состояния в типе рабочего элемента процесса.
getStateDefinitions(string, string)	Возвращает список всех определений состояний в типе рабочего элемента процесса.
getSystemControls(string, string)	Возвращает измененные системные элементы управления для типа рабочего элемента в процессе. Чтобы получить все системные элементы управления (базовые и измененные) используйте API макета
getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)	Возвращает поле в типе рабочего элемента.
hideStateDefinition(HideStateModel, string, string, string)	Скрывает определение состояния в типе рабочего элемента процесса. Скрыть можно только состояния с параметром customizationType:System.
moveControlToGroup(Control, string, string, string, string, string)	Перемещает элемент управления в указанную группу.
moveGroupToPage(Group, string, string, string, string, string, string, string)	Перемещает группу на другую страницу и раздел.
moveGroupToSection(Group, string, string, string, string, string, string)	Перемещает группу в другой раздел.
removeBehaviorFromWorkItemType(string, string, string)	Удаляет поведение для типа рабочего элемента процесса.
removeControlFromGroup(string, string, string, string)	Удаляет элемент управления из формы рабочего элемента.
removeGroup(string, string, string, string, string)	Удаляет группу из формы рабочего элемента.
removePage(string, string, string)	Удаляет страницу из формы рабочего элемента
removeWorkItemTypeField(string, string, string)	Удаляет поле из типа рабочего элемента. Не удаляет поле без возможности восстановления.
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Обновления поведение для типа рабочего элемента процесса.
updateControl(Control, string, string, string, string)	Обновления элемент управления в форме рабочего элемента.
updateGroup(Group, string, string, string, string, string)	Обновления группу в форме рабочего элемента.
updateList(PickList, string)	Обновления список.
updatePage(Page, string, string)	Обновления страницы в форме рабочего элемента
updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)	Заменяет поведение в процессе.
updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)	Обновления тип рабочего элемента процесса.
updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)	Обновления правило в типе рабочего элемента процесса.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	Обновления заданное определение состояния в типе рабочего элемента процесса.
updateSystemControl(Control, string, string, string)	Обновления или добавляет системный элемент управления в форму рабочего элемента.
updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)	Обновления поле в типе рабочего элемента.

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

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessRestClient(options: IVssRestClientOptions)

Параметры

options: IVssRestClientOptions

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

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

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

string

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

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

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

function addBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>

Параметры

behavior: WorkItemTypeBehavior

processId: string

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

witRefNameForBehaviors: string

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

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

Promise<WorkItemTypeBehavior>

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

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

function addFieldToWorkItemType(field: AddProcessWorkItemTypeFieldRequest, processId: string, witRefName: string): Promise<ProcessWorkItemTypeField>

Параметры

field: AddProcessWorkItemTypeFieldRequest

processId: string

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

witRefName: string

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

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

Promise<ProcessWorkItemTypeField>

addGroup(Group, string, string, string, string)

Добавляет группу в форму рабочего элемента.

function addGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string): Promise<Group>

Параметры

group: Group

Группа.

processId: string

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

witRefName: string

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

pageId: string

Идентификатор страницы, на который добавляется группа.

sectionId: string

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

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

Promise<Group>

addPage(Page, string, string)

Добавляет страницу в форму рабочего элемента.

function addPage(page: Page, processId: string, witRefName: string): Promise<Page>

Параметры

page: Page

Страница.

processId: string

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

witRefName: string

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

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

Promise<Page>

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

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

function addProcessWorkItemTypeRule(processRuleCreate: CreateProcessRuleRequest, processId: string, witRefName: string): Promise<ProcessRule>

Параметры

processRuleCreate: CreateProcessRuleRequest

processId: string

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

witRefName: string

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

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

Promise<ProcessRule>

createControlInGroup(Control, string, string, string)

Создает элемент управления в группе.

function createControlInGroup(control: Control, processId: string, witRefName: string, groupId: string): Promise<Control>

Параметры

control: Control

Элемент управления.

processId: string

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

witRefName: string

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

groupId: string

Идентификатор группы, в который добавляется элемент управления.

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

Promise<Control>

createList(PickList)

Создает список выбора.

function createList(picklist: PickList): Promise<PickList>

Параметры

picklist: PickList

Список выбора

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

Promise<PickList>

createNewProcess(CreateProcessModel)

Создает процесс.

function createNewProcess(createRequest: CreateProcessModel): Promise<ProcessInfo>

Параметры

createRequest: CreateProcessModel

CreateProcessModel.

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

Promise<ProcessInfo>

createProcessBehavior(ProcessBehaviorCreateRequest, string)

Создает единое поведение в заданном процессе.

function createProcessBehavior(behavior: ProcessBehaviorCreateRequest, processId: string): Promise<ProcessBehavior>

Параметры

behavior: ProcessBehaviorCreateRequest

processId: string

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

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

Promise<ProcessBehavior>

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

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

function createProcessWorkItemType(workItemType: CreateProcessWorkItemTypeRequest, processId: string): Promise<ProcessWorkItemType>

Параметры

workItemType: CreateProcessWorkItemTypeRequest

processId: string

Идентификатор процесса, в котором создается тип рабочего элемента.

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

Promise<ProcessWorkItemType>

createStateDefinition(WorkItemStateInputModel, string, string)

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

function createStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string): Promise<WorkItemStateResultModel>

Параметры

stateModel: WorkItemStateInputModel

processId: string

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

witRefName: string

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

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

Promise<WorkItemStateResultModel>

deleteList(string)

Удаляет список выбора.

function deleteList(listId: string): Promise<void>

Параметры

listId: string

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

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

Promise<void>

deleteProcessBehavior(string, string)

Удаляет поведение в процессе.

function deleteProcessBehavior(processId: string, behaviorRefName: string): Promise<void>

Параметры

processId: string

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

behaviorRefName: string

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

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

Promise<void>

deleteProcessById(string)

Удаляет процесс с определенным идентификатором.

function deleteProcessById(processTypeId: string): Promise<void>

Параметры

processTypeId: string

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

Promise<void>

deleteProcessWorkItemType(string, string)

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

function deleteProcessWorkItemType(processId: string, witRefName: string): Promise<void>

Параметры

processId: string

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

witRefName: string

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

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

Promise<void>

deleteProcessWorkItemTypeRule(string, string, string)

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

function deleteProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise<void>

Параметры

processId: string

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

witRefName: string

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

ruleId: string

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

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

Promise<void>

deleteStateDefinition(string, string, string)

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

function deleteStateDefinition(processId: string, witRefName: string, stateId: string): Promise<void>

Параметры

processId: string

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

witRefName: string

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

stateId: string

Идентификатор состояния

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

Promise<void>

deleteSystemControl(string, string, string)

Удаляет изменение системного элемента управления в форме рабочего элемента.

function deleteSystemControl(processId: string, witRefName: string, controlId: string): Promise<Control[]>

Параметры

processId: string

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

witRefName: string

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

controlId: string

Идентификатор элемента управления.

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

Promise<Control[]>

editProcess(UpdateProcessModel, string)

Изменение процесса с определенным идентификатором.

function editProcess(updateRequest: UpdateProcessModel, processTypeId: string): Promise<ProcessInfo>

Параметры

updateRequest: UpdateProcessModel

processTypeId: string

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

Promise<ProcessInfo>

getAllWorkItemTypeFields(string, string)

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

function getAllWorkItemTypeFields(processId: string, witRefName: string): Promise<ProcessWorkItemTypeField[]>

Параметры

processId: string

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

witRefName: string

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

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

Promise<ProcessWorkItemTypeField[]>

getBehaviorForWorkItemType(string, string, string)

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

function getBehaviorForWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<WorkItemTypeBehavior>

Параметры

processId: string

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

witRefNameForBehaviors: string

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

behaviorRefName: string

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

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

Promise<WorkItemTypeBehavior>

getBehaviorsForWorkItemType(string, string)

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

function getBehaviorsForWorkItemType(processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior[]>

Параметры

processId: string

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

witRefNameForBehaviors: string

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

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

Promise<WorkItemTypeBehavior[]>

getFormLayout(string, string)

Возвращает макет формы.

function getFormLayout(processId: string, witRefName: string): Promise<FormLayout>

Параметры

processId: string

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

witRefName: string

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

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

Promise<FormLayout>

getList(string)

Возвращает список выбора.

function getList(listId: string): Promise<PickList>

Параметры

listId: string

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

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

Promise<PickList>

getListOfProcesses(GetProcessExpandLevel)

Получение списка всех процессов, включая системные и унаследованные.

function getListOfProcesses(expand?: GetProcessExpandLevel): Promise<ProcessInfo[]>

Параметры

expand: GetProcessExpandLevel

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

Promise<ProcessInfo[]>

getListsMetadata()

Возвращает метаданные списка выбора.

function getListsMetadata(): Promise<PickListMetadata[]>

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

Promise<PickListMetadata[]>

getProcessBehavior(string, string, GetBehaviorsExpand)

Возвращает поведение процесса.

function getProcessBehavior(processId: string, behaviorRefName: string, expand?: GetBehaviorsExpand): Promise<ProcessBehavior>

Параметры

processId: string

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

behaviorRefName: string

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

expand: GetBehaviorsExpand

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

Promise<ProcessBehavior>

getProcessBehaviors(string, GetBehaviorsExpand)

Возвращает список всех поведений в процессе.

function getProcessBehaviors(processId: string, expand?: GetBehaviorsExpand): Promise<ProcessBehavior[]>

Параметры

processId: string

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

expand: GetBehaviorsExpand

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

Promise<ProcessBehavior[]>

getProcessByItsId(string, GetProcessExpandLevel)

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

function getProcessByItsId(processTypeId: string, expand?: GetProcessExpandLevel): Promise<ProcessInfo>

Параметры

processTypeId: string

expand: GetProcessExpandLevel

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

Promise<ProcessInfo>

getProcessWorkItemType(string, string, GetWorkItemTypeExpand)

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

function getProcessWorkItemType(processId: string, witRefName: string, expand?: GetWorkItemTypeExpand): Promise<ProcessWorkItemType>

Параметры

processId: string

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

witRefName: string

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

expand: GetWorkItemTypeExpand

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

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

Promise<ProcessWorkItemType>

getProcessWorkItemTypeRule(string, string, string)

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

function getProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise<ProcessRule>

Параметры

processId: string

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

witRefName: string

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

ruleId: string

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

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

Promise<ProcessRule>

getProcessWorkItemTypeRules(string, string)

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

function getProcessWorkItemTypeRules(processId: string, witRefName: string): Promise<ProcessRule[]>

Параметры

processId: string

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

witRefName: string

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

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

Promise<ProcessRule[]>

getProcessWorkItemTypes(string, GetWorkItemTypeExpand)

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

function getProcessWorkItemTypes(processId: string, expand?: GetWorkItemTypeExpand): Promise<ProcessWorkItemType[]>

Параметры

processId: string

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

expand: GetWorkItemTypeExpand

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

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

Promise<ProcessWorkItemType[]>

getStateDefinition(string, string, string)

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

function getStateDefinition(processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>

Параметры

processId: string

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

witRefName: string

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

stateId: string

Идентификатор состояния

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

Promise<WorkItemStateResultModel>

getStateDefinitions(string, string)

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

function getStateDefinitions(processId: string, witRefName: string): Promise<WorkItemStateResultModel[]>

Параметры

processId: string

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

witRefName: string

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

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

Promise<WorkItemStateResultModel[]>

getSystemControls(string, string)

Возвращает измененные системные элементы управления для типа рабочего элемента в процессе. Чтобы получить все системные элементы управления (базовые и измененные) используйте API макета

function getSystemControls(processId: string, witRefName: string): Promise<Control[]>

Параметры

processId: string

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

witRefName: string

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

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

Promise<Control[]>

getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)

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

function getWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string, expand?: ProcessWorkItemTypeFieldsExpandLevel): Promise<ProcessWorkItemTypeField>

Параметры

processId: string

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

witRefName: string

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

fieldRefName: string

Имя ссылки поля.

expand: ProcessWorkItemTypeFieldsExpandLevel

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

Promise<ProcessWorkItemTypeField>

hideStateDefinition(HideStateModel, string, string, string)

Скрывает определение состояния в типе рабочего элемента процесса. Скрыть можно только состояния с параметром customizationType:System.

function hideStateDefinition(hideStateModel: HideStateModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>

Параметры

hideStateModel: HideStateModel

processId: string

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

witRefName: string

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

stateId: string

Идентификатор состояния

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

Promise<WorkItemStateResultModel>

moveControlToGroup(Control, string, string, string, string, string)

Перемещает элемент управления в указанную группу.

function moveControlToGroup(control: Control, processId: string, witRefName: string, groupId: string, controlId: string, removeFromGroupId?: string): Promise<Control>

Параметры

control: Control

Элемент управления.

processId: string

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

witRefName: string

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

groupId: string

Идентификатор группы, в который перемещается элемент управления.

controlId: string

Идентификатор элемента управления.

removeFromGroupId: string

Идентификатор группы для удаления элемента управления.

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

Promise<Control>

moveGroupToPage(Group, string, string, string, string, string, string, string)

Перемещает группу на другую страницу и раздел.

function moveGroupToPage(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromPageId: string, removeFromSectionId: string): Promise<Group>

Параметры

group: Group

Обновленная группа.

processId: string

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

witRefName: string

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

pageId: string

Идентификатор страницы, на который находится группа.

sectionId: string

Идентификатор раздела, в который входит группа, — i.n

groupId: string

Идентификатор группы.

removeFromPageId: string

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

removeFromSectionId: string

Идентификатор раздела, из который нужно удалить группу.

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

Promise<Group>

moveGroupToSection(Group, string, string, string, string, string, string)

Перемещает группу в другой раздел.

function moveGroupToSection(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromSectionId: string): Promise<Group>

Параметры

group: Group

Обновленная группа.

processId: string

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

witRefName: string

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

pageId: string

Идентификатор страницы, на который находится группа.

sectionId: string

Идентификатор раздела, в который входит группа.

groupId: string

Идентификатор группы.

removeFromSectionId: string

Идентификатор раздела, из который нужно удалить группу.

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

Promise<Group>

removeBehaviorFromWorkItemType(string, string, string)

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

function removeBehaviorFromWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<void>

Параметры

processId: string

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

witRefNameForBehaviors: string

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

behaviorRefName: string

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

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

Promise<void>

removeControlFromGroup(string, string, string, string)

Удаляет элемент управления из формы рабочего элемента.

function removeControlFromGroup(processId: string, witRefName: string, groupId: string, controlId: string): Promise<void>

Параметры

processId: string

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

witRefName: string

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

groupId: string

Идентификатор группы.

controlId: string

Идентификатор удаляемого элемента управления.

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

Promise<void>

removeGroup(string, string, string, string, string)

Удаляет группу из формы рабочего элемента.

function removeGroup(processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<void>

Параметры

processId: string

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

witRefName: string

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

pageId: string

Идентификатор страницы, на который находится группа

sectionId: string

Идентификатор раздела для группы находится в

groupId: string

Идентификатор группы

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

Promise<void>

removePage(string, string, string)

Удаляет страницу из формы рабочего элемента

function removePage(processId: string, witRefName: string, pageId: string): Promise<void>

Параметры

processId: string

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

witRefName: string

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

pageId: string

Идентификатор страницы

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

Promise<void>

removeWorkItemTypeField(string, string, string)

Удаляет поле из типа рабочего элемента. Не удаляет поле без возможности восстановления.

function removeWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string): Promise<void>

Параметры

processId: string

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

witRefName: string

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

fieldRefName: string

Имя ссылки поля.

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

Promise<void>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

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

function updateBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>

Параметры

behavior: WorkItemTypeBehavior

processId: string

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

witRefNameForBehaviors: string

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

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

Promise<WorkItemTypeBehavior>

updateControl(Control, string, string, string, string)

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

function updateControl(control: Control, processId: string, witRefName: string, groupId: string, controlId: string): Promise<Control>

Параметры

control: Control

Обновленный элемент управления.

processId: string

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

witRefName: string

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

groupId: string

Идентификатор группы.

controlId: string

Идентификатор элемента управления.

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

Promise<Control>

updateGroup(Group, string, string, string, string, string)

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

function updateGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<Group>

Параметры

group: Group

Обновленная группа.

processId: string

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

witRefName: string

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

pageId: string

Идентификатор страницы, на который находится группа.

sectionId: string

Идентификатор раздела, в который входит группа.

groupId: string

Идентификатор группы.

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

Promise<Group>

updateList(PickList, string)

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

function updateList(picklist: PickList, listId: string): Promise<PickList>

Параметры

picklist: PickList

listId: string

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

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

Promise<PickList>

updatePage(Page, string, string)

Обновления страницы в форме рабочего элемента

function updatePage(page: Page, processId: string, witRefName: string): Promise<Page>

Параметры

page: Page

Страница

processId: string

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

witRefName: string

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

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

Promise<Page>

updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)

Заменяет поведение в процессе.

function updateProcessBehavior(behaviorData: ProcessBehaviorUpdateRequest, processId: string, behaviorRefName: string): Promise<ProcessBehavior>

Параметры

behaviorData: ProcessBehaviorUpdateRequest

processId: string

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

behaviorRefName: string

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

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

Promise<ProcessBehavior>

updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)

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

function updateProcessWorkItemType(workItemTypeUpdate: UpdateProcessWorkItemTypeRequest, processId: string, witRefName: string): Promise<ProcessWorkItemType>

Параметры

workItemTypeUpdate: UpdateProcessWorkItemTypeRequest

processId: string

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

witRefName: string

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

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

Promise<ProcessWorkItemType>

updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)

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

function updateProcessWorkItemTypeRule(processRule: UpdateProcessRuleRequest, processId: string, witRefName: string, ruleId: string): Promise<ProcessRule>

Параметры

processRule: UpdateProcessRuleRequest

processId: string

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

witRefName: string

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

ruleId: string

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

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

Promise<ProcessRule>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

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

function updateStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>

Параметры

stateModel: WorkItemStateInputModel

processId: string

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

witRefName: string

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

stateId: string

Идентификатор состояния

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

Promise<WorkItemStateResultModel>

updateSystemControl(Control, string, string, string)

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

function updateSystemControl(control: Control, processId: string, witRefName: string, controlId: string): Promise<Control>

Параметры

control: Control

processId: string

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

witRefName: string

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

controlId: string

Идентификатор элемента управления.

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

Promise<Control>

updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)

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

function updateWorkItemTypeField(field: UpdateProcessWorkItemTypeFieldRequest, processId: string, witRefName: string, fieldRefName: string): Promise<ProcessWorkItemTypeField>

Параметры

field: UpdateProcessWorkItemTypeFieldRequest

processId: string

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

witRefName: string

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

fieldRefName: string

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

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

Promise<ProcessWorkItemTypeField>

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

WorkItemTrackingProcessRestClient class

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

Свойства

Методы

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

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

Параметры

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

RESOURCE_AREA_ID

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

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

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Параметры

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

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

Параметры

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

addGroup(Group, string, string, string, string)

Параметры

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

addPage(Page, string, string)

Параметры

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

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

Параметры

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

createControlInGroup(Control, string, string, string)

Параметры

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

createList(PickList)

Параметры

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

createNewProcess(CreateProcessModel)

Параметры

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

createProcessBehavior(ProcessBehaviorCreateRequest, string)

Параметры

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

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

Параметры

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

createStateDefinition(WorkItemStateInputModel, string, string)

Параметры

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

deleteList(string)

Параметры

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

deleteProcessBehavior(string, string)

Параметры

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

deleteProcessById(string)

Параметры

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

deleteProcessWorkItemType(string, string)

Параметры

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

deleteProcessWorkItemTypeRule(string, string, string)

Параметры

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

deleteStateDefinition(string, string, string)

Параметры

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

deleteSystemControl(string, string, string)

Параметры

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

editProcess(UpdateProcessModel, string)

Параметры

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

getAllWorkItemTypeFields(string, string)

Параметры

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

getBehaviorForWorkItemType(string, string, string)

Параметры

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

getBehaviorsForWorkItemType(string, string)

Параметры

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

getFormLayout(string, string)

Параметры