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


WorkItemTrackingProcessDefinitionsRestClient class

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

Extends

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

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

Свойства

RESOURCE_AREA_ID

Методы

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

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

addControlToGroup(Control, string, string, string)

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

addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)

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

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

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

addPage(Page, string, string)

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

createBehavior(BehaviorCreateModel, string)

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

createField(FieldModel, string)

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

createList(PickListModel)

Создает раскрывающийся список.

createStateDefinition(WorkItemStateInputModel, string, string)

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

createWorkItemType(WorkItemTypeModel, string)

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

deleteBehavior(string, string)

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

deleteList(string)

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

deleteStateDefinition(string, string, string)

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

deleteWorkItemType(string, string)

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

editControl(Control, string, string, string, string)

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

editGroup(Group, string, string, string, string, string)

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

editPage(Page, string, string)

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

getBehavior(string, string)

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

getBehaviorForWorkItemType(string, string, string)

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

getBehaviors(string)

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

getBehaviorsForWorkItemType(string, string)

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

getFormLayout(string, string)

Получает макет формы

getList(string)

Возвращает раскрывающийся список.

getListsMetadata()

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

getStateDefinition(string, string, string)

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

getStateDefinitions(string, string)

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

getWorkItemType(string, string, GetWorkItemTypeExpand)

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

getWorkItemTypeField(string, string, string)

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

getWorkItemTypeFields(string, string)

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

getWorkItemTypes(string, GetWorkItemTypeExpand)

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

hideStateDefinition(HideStateModel, string, string, string)

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

removeBehaviorFromWorkItemType(string, string, string)

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

removeControlFromGroup(string, string, string, string)

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

removeFieldFromWorkItemType(string, string, string)

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

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

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

removePage(string, string, string)

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

replaceBehavior(BehaviorReplaceModel, string, string)

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

setControlInGroup(Control, string, string, string, string, string)

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

setGroupInPage(Group, string, string, string, string, string, string, string)

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

setGroupInSection(Group, string, string, string, string, string, string)

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

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

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

updateField(FieldUpdate, string)

Обновляет заданное поле в процессе.

updateList(PickListModel, string)

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

updateStateDefinition(WorkItemStateInputModel, string, string, string)

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

updateWorkItemType(WorkItemTypeUpdateModel, string, string)

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

updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)

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

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

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessDefinitionsRestClient(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>

Параметры

processId

string

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

witRefNameForBehaviors

string

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

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

addControlToGroup(Control, string, string, string)

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

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

Параметры

control
Control

Управление

processId

string

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

witRefName

string

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

groupId

string

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

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

Promise<Control>

addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)

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

function addFieldToWorkItemType(field: WorkItemTypeFieldModel2, processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2>

Параметры

processId

string

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

witRefNameForFields

string

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

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

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>

createBehavior(BehaviorCreateModel, string)

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

function createBehavior(behavior: BehaviorCreateModel, processId: string): Promise<BehaviorModel>

Параметры

processId

string

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

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

Promise<BehaviorModel>

createField(FieldModel, string)

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

function createField(field: FieldModel, processId: string): Promise<FieldModel>

Параметры

field
FieldModel
processId

string

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

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

Promise<FieldModel>

createList(PickListModel)

Создает раскрывающийся список.

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

Параметры

picklist
PickListModel

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

Promise<PickListModel>

createStateDefinition(WorkItemStateInputModel, string, string)

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

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

Параметры

processId

string

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

witRefName

string

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

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

createWorkItemType(WorkItemTypeModel, string)

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

function createWorkItemType(workItemType: WorkItemTypeModel, processId: string): Promise<WorkItemTypeModel>

Параметры

workItemType
WorkItemTypeModel
processId

string

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

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

deleteBehavior(string, string)

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

function deleteBehavior(processId: string, behaviorId: string): Promise<void>

Параметры

processId

string

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

behaviorId

string

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

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

Promise<void>

deleteList(string)

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

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

Параметры

listId

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>

deleteWorkItemType(string, string)

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

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

Параметры

processId

string

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

witRefName

string

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

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

Promise<void>

editControl(Control, string, string, string, string)

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

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

Параметры

control
Control

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

processId

string

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

witRefName

string

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

groupId

string

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

controlId

string

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

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

Promise<Control>

editGroup(Group, string, string, string, string, string)

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

function editGroup(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>

editPage(Page, string, string)

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

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

Параметры

page
Page

Страница

processId

string

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

witRefName

string

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

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

Promise<Page>

getBehavior(string, string)

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

function getBehavior(processId: string, behaviorId: string): Promise<BehaviorModel>

Параметры

processId

string

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

behaviorId

string

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

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

Promise<BehaviorModel>

getBehaviorForWorkItemType(string, string, string)

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

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

Параметры

processId

string

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

witRefNameForBehaviors

string

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

behaviorRefName

string

Ссылочное имя поведения

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

getBehaviors(string)

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

function getBehaviors(processId: string): Promise<BehaviorModel[]>

Параметры

processId

string

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

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

Promise<BehaviorModel[]>

getBehaviorsForWorkItemType(string, string)

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

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

Параметры

processId

string

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

witRefNameForBehaviors

string

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

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

getFormLayout(string, string)

Получает макет формы

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

Параметры

processId

string

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

witRefName

string

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

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

Promise<FormLayout>

getList(string)

Возвращает раскрывающийся список.

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

Параметры

listId

string

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

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

Promise<PickListModel>

getListsMetadata()

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

function getListsMetadata(): Promise<PickListMetadataModel[]>

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

getStateDefinition(string, string, string)

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

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

Параметры

processId

string

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

witRefName

string

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

stateId

string

Идентификатор государства

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

getStateDefinitions(string, string)

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

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

Параметры

processId

string

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

witRefName

string

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

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

getWorkItemType(string, string, GetWorkItemTypeExpand)

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

function getWorkItemType(processId: string, witRefName: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel>

Параметры

processId

string

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

witRefName

string

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

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

getWorkItemTypeField(string, string, string)

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

function getWorkItemTypeField(processId: string, witRefNameForFields: string, fieldRefName: string): Promise<WorkItemTypeFieldModel2>

Параметры

processId

string

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

witRefNameForFields

string

Ссылочное имя типа рабочего элемента для полей

fieldRefName

string

Ссылочное имя поля

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

getWorkItemTypeFields(string, string)

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

function getWorkItemTypeFields(processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2[]>

Параметры

processId

string

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

witRefNameForFields

string

Ссылочное имя типа рабочего элемента для полей

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

getWorkItemTypes(string, GetWorkItemTypeExpand)

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

function getWorkItemTypes(processId: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel[]>

Параметры

processId

string

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

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

Promise<WorkItemTypeModel[]>

hideStateDefinition(HideStateModel, string, string, string)

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

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

Параметры

hideStateModel
HideStateModel
processId

string

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

witRefName

string

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

stateId

string

Идентификатор государства

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

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>

removeFieldFromWorkItemType(string, string, string)

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

function removeFieldFromWorkItemType(processId: string, witRefNameForFields: string, fieldRefName: string): Promise<void>

Параметры

processId

string

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

witRefNameForFields

string

Ссылочное имя типа рабочего элемента для полей

fieldRefName

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

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

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>

replaceBehavior(BehaviorReplaceModel, string, string)

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

function replaceBehavior(behaviorData: BehaviorReplaceModel, processId: string, behaviorId: string): Promise<BehaviorModel>

Параметры

behaviorData
BehaviorReplaceModel
processId

string

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

behaviorId

string

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

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

Promise<BehaviorModel>

setControlInGroup(Control, string, string, string, string, string)

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

function setControlInGroup(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>

setGroupInPage(Group, string, string, string, string, string, string, string)

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

function setGroupInPage(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

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

groupId

string

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

removeFromPageId

string

ID страницы, с которой нужно удалить группу

removeFromSectionId

string

ID раздела, из которого нужно удалить группу

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

Promise<Group>

setGroupInSection(Group, string, string, string, string, string, string)

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

function setGroupInSection(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

ID раздела, из которого нужно удалить группу

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

Promise<Group>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

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

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

Параметры

processId

string

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

witRefNameForBehaviors

string

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

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

updateField(FieldUpdate, string)

Обновляет заданное поле в процессе.

function updateField(field: FieldUpdate, processId: string): Promise<FieldModel>

Параметры

field
FieldUpdate
processId

string

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

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

Promise<FieldModel>

updateList(PickListModel, string)

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

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

Параметры

picklist
PickListModel
listId

string

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

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

Promise<PickListModel>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

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

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

Параметры

processId

string

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

witRefName

string

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

stateId

string

Идентификатор государства

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

updateWorkItemType(WorkItemTypeUpdateModel, string, string)

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

function updateWorkItemType(workItemTypeUpdate: WorkItemTypeUpdateModel, processId: string, witRefName: string): Promise<WorkItemTypeModel>

Параметры

workItemTypeUpdate
WorkItemTypeUpdateModel
processId

string

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

witRefName

string

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

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

updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)

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

function updateWorkItemTypeField(field: WorkItemTypeFieldModel2, processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2>

Параметры

field
WorkItemTypeFieldModel2

Модель, с помощью которой обновляется поле

processId

string

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

witRefNameForFields

string

Ссылочное имя типа рабочего элемента для полей

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