WorkItemTrackingProcessDefinitionsRestClient class
Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS
- Extends
Конструкторы
Work |
Свойства
RESOURCE_AREA_ID |
Методы
add |
Добавляет поведение к типу рабочего элемента процесса. |
add |
Создает элемент управления в группе |
add |
Добавляет поле к типу рабочего элемента в процессе. |
add |
Добавление группы в форму рабочего элемента |
add |
Добавление страницы в форму рабочего элемента |
create |
Создает единое поведение в данном процессе. |
create |
Создает одно поле в процессе. |
create |
Создает список выбора. |
create |
Создает определение состояния в типе рабочего элемента процесса. |
create |
Создает тип рабочего элемента в процессе. |
delete |
Удаляет поведение в процессе. |
delete |
Удаляет список выбора. |
delete |
Удаляет определение состояния в типе рабочего элемента процесса. |
delete |
Удаляет тип рабочего элемента в процессе. |
edit |
Обновления элемента управления в форме рабочего элемента |
edit |
Обновления группы в форме рабочего элемента |
edit |
Обновления страницы в форме рабочего элемента |
get |
Возвращает одно поведение в процессе. |
get |
Возвращает поведение для типа рабочего элемента процесса. |
get |
Возвращает список всех поведений в процессе. |
get |
Возвращает список всех поведений для типа рабочего элемента процесса. |
get |
Возвращает макет формы |
get |
Возвращает список выбора. |
get |
Возвращает метаданные списка выбора. |
get |
Возвращает определение состояния в типе рабочего элемента процесса. |
get |
Возвращает список всех определений состояний в типе рабочего элемента процесса. |
get |
Возвращает тип рабочего элемента процесса. |
get |
Возвращает одно поле в типе рабочего элемента процесса. |
get |
Возвращает список всех полей в типе рабочего элемента процесса. |
get |
Возвращает список всех типов рабочих элементов в процессе. |
hide |
Скрывает определение состояния в типе рабочего элемента процесса. |
remove |
Удаляет поведение для типа рабочего элемента процесса. |
remove |
Удаляет элемент управления из формы рабочего элемента |
remove |
Удаляет поле в типе рабочего элемента процесса. |
remove |
Удаляет группу из формы рабочего элемента |
remove |
Удаляет страницу из формы рабочего элемента |
replace |
Заменяет поведение в процессе. |
set |
Перемещение элемента управления в новую группу |
set |
Перемещение группы на другую страницу и раздел |
set |
Перемещение группы в другой раздел |
update |
Обновления тип рабочего элемента по умолчанию для поведения процесса. |
update |
Обновления заданное поле в процессе. |
update |
Обновления список. |
update |
Обновления заданное определение состояния в типе рабочего элемента процесса. |
update |
Обновления тип рабочего элемента процесса. |
update |
Обновления одно поле в область данного процесса и типа рабочего элемента. |
Сведения о конструкторе
WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)
new WorkItemTrackingProcessDefinitionsRestClient(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>
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>
Параметры
- field
- WorkItemTypeFieldModel2
- processId
-
string
Идентификатор процесса
- witRefNameForFields
-
string
Имя ссылки типа рабочего элемента для поля
Возвращаемое значение
Promise<WorkItemTypeFieldModel2>
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>
Параметры
- behavior
- BehaviorCreateModel
- 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>
Параметры
- stateModel
- WorkItemStateInputModel
- processId
-
string
Идентификатор процесса
- witRefName
-
string
Имя ссылки типа рабочего элемента
Возвращаемое значение
Promise<WorkItemStateResultModel>
createWorkItemType(WorkItemTypeModel, string)
Создает тип рабочего элемента в процессе.
function createWorkItemType(workItemType: WorkItemTypeModel, processId: string): Promise<WorkItemTypeModel>
Параметры
- workItemType
- WorkItemTypeModel
- processId
-
string
Идентификатор процесса
Возвращаемое значение
Promise<WorkItemTypeModel>
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
Имя ссылки на поведение
Возвращаемое значение
Promise<WorkItemTypeBehavior>
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
Эталонное имя типа рабочего элемента для поведения
Возвращаемое значение
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<PickListModel>
Параметры
- listId
-
string
Идентификатор списка
Возвращаемое значение
Promise<PickListModel>
getListsMetadata()
Возвращает метаданные списка выбора.
function getListsMetadata(): Promise<PickListMetadataModel[]>
Возвращаемое значение
Promise<PickListMetadataModel[]>
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[]>
getWorkItemType(string, string, GetWorkItemTypeExpand)
Возвращает тип рабочего элемента процесса.
function getWorkItemType(processId: string, witRefName: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel>
Параметры
- processId
-
string
Идентификатор процесса
- witRefName
-
string
Имя ссылки типа рабочего элемента
- expand
- GetWorkItemTypeExpand
Возвращаемое значение
Promise<WorkItemTypeModel>
getWorkItemTypeField(string, string, string)
Возвращает одно поле в типе рабочего элемента процесса.
function getWorkItemTypeField(processId: string, witRefNameForFields: string, fieldRefName: string): Promise<WorkItemTypeFieldModel2>
Параметры
- processId
-
string
Идентификатор процесса
- witRefNameForFields
-
string
Имя ссылки на тип рабочего элемента для полей
- fieldRefName
-
string
Имя ссылки для поля
Возвращаемое значение
Promise<WorkItemTypeFieldModel2>
getWorkItemTypeFields(string, string)
Возвращает список всех полей в типе рабочего элемента процесса.
function getWorkItemTypeFields(processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2[]>
Параметры
- processId
-
string
Идентификатор процесса
- witRefNameForFields
-
string
Имя ссылки на тип рабочего элемента для полей
Возвращаемое значение
Promise<WorkItemTypeFieldModel2[]>
getWorkItemTypes(string, GetWorkItemTypeExpand)
Возвращает список всех типов рабочих элементов в процессе.
function getWorkItemTypes(processId: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel[]>
Параметры
- processId
-
string
Идентификатор процесса
- expand
- GetWorkItemTypeExpand
Возвращаемое значение
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
Идентификатор состояния
Возвращаемое значение
Promise<WorkItemStateResultModel>
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
Идентификатор раздела для группы находится в
- 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
Идентификатор страницы для удаления группы
- removeFromSectionId
-
string
Идентификатор раздела, из который нужно удалить группу
Возвращаемое значение
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
Идентификатор раздела, из который нужно удалить группу
Возвращаемое значение
Promise<Group>
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)
Обновления тип рабочего элемента по умолчанию для поведения процесса.
function updateBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>
Параметры
- behavior
- WorkItemTypeBehavior
- processId
-
string
Идентификатор процесса
- witRefNameForBehaviors
-
string
Эталонное имя типа рабочего элемента для поведения
Возвращаемое значение
Promise<WorkItemTypeBehavior>
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>
Параметры
- stateModel
- WorkItemStateInputModel
- processId
-
string
Идентификатор процесса
- witRefName
-
string
Имя ссылки типа рабочего элемента
- stateId
-
string
Идентификатор состояния
Возвращаемое значение
Promise<WorkItemStateResultModel>
updateWorkItemType(WorkItemTypeUpdateModel, string, string)
Обновления тип рабочего элемента процесса.
function updateWorkItemType(workItemTypeUpdate: WorkItemTypeUpdateModel, processId: string, witRefName: string): Promise<WorkItemTypeModel>
Параметры
- workItemTypeUpdate
- WorkItemTypeUpdateModel
- processId
-
string
Идентификатор процесса
- witRefName
-
string
Имя ссылки типа рабочего элемента
Возвращаемое значение
Promise<WorkItemTypeModel>
updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)
Обновления одно поле в область данного процесса и типа рабочего элемента.
function updateWorkItemTypeField(field: WorkItemTypeFieldModel2, processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2>
Параметры
- field
- WorkItemTypeFieldModel2
Модель, с помощью которой обновляется поле
- processId
-
string
Идентификатор процесса
- witRefNameForFields
-
string
Имя ссылки на тип рабочего элемента для полей
Возвращаемое значение
Promise<WorkItemTypeFieldModel2>