WorkItemTrackingProcessRestClient class

new WorkItemTrackingProcessRestClient(options: IVssRestClientOptions)

パラメーター

static RESOURCE_AREA_ID: string

プロパティ値

プロセスの作業項目の種類に動作を追加します。

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

パラメーター

戻り値

作業項目の種類にフィールドを追加します。

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

パラメーター

戻り値

作業項目フォームにグループを追加します。

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

パラメーター

戻り値

作業項目フォームにページを追加します。

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

パラメーター

戻り値

プロセス内の作業項目の種類にルールを追加します。

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

パラメーター

戻り値

グループ内にコントロールを作成します。

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

パラメーター

戻り値

候補リストを作成します。

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

パラメーター

戻り値

プロセスを作成します。

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

パラメーター

戻り値

指定されたプロセスで 1 つの動作を作成します。

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

パラメーター

戻り値

プロセスで作業項目の種類を作成します。

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

パラメーター

戻り値

プロセスの作業項目の種類に状態定義を作成します。

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

パラメーター

戻り値

候補リストを削除します。

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

パラメーター

戻り値

プロセス内の動作を削除します。

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

パラメーター

戻り値

特定の ID のプロセスを削除します。

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

パラメーター

戻り値

プロセス内の作業項目の種類を削除します。

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

パラメーター

戻り値

プロセス内の作業項目の種類からルールを削除します。

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

パラメーター

戻り値

プロセスの作業項目の種類の状態定義を削除します。

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

パラメーター

戻り値

作業項目フォームのシステム コントロールの変更を削除します。

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

パラメーター

戻り値

特定の ID のプロセスを編集します。

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

パラメーター

戻り値

作業項目の種類のすべてのフィールドの一覧を返します。

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

パラメーター

戻り値

プロセスの作業項目の種類の動作を返します。

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

パラメーター

戻り値

プロセスの作業項目の種類のすべての動作の一覧を返します。

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

パラメーター

戻り値

フォーム レイアウトを取得します。

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

パラメーター

戻り値

候補リストを返します。

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

パラメーター

戻り値

システムと継承を含むすべてのプロセスの一覧を取得します。

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

パラメーター

戻り値

候補リストのメタデータを返します。

function getListsMetadata(): Promise<PickListMetadata[]>

戻り値

プロセスの動作を返します。

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

パラメーター

戻り値

プロセス内のすべての動作の一覧を返します。

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

パラメーター

戻り値

指定した ID の 1 つのプロセスを取得します。

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

パラメーター

戻り値

プロセス内の 1 つの作業項目の種類を返します。

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

パラメーター

戻り値

プロセスの作業項目の種類で 1 つのルールを返します。

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

パラメーター

戻り値

プロセスの作業項目の種類内のすべてのルールの一覧を返します。

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

パラメーター

戻り値

プロセス内のすべての作業項目の種類の一覧を返します。

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

パラメーター

戻り値

プロセスの作業項目の種類で 1 つの状態定義を返します。

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

パラメーター

戻り値

プロセスの作業項目の種類内のすべての状態定義の一覧を返します。

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

パラメーター

戻り値

プロセス内の作業項目の種類に対して編集されたシステム コントロールを取得します。 すべてのシステム コントロール (基本 + 編集済み) を取得するには、レイアウト API を使用します

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

パラメーター

戻り値

作業項目の種類のフィールドを返します。

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

パラメーター

戻り値

プロセスの作業項目の種類の状態定義を非表示にします。customizationType:System の状態のみを非表示にすることができます。

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

パラメーター

戻り値

コントロールを指定したグループに移動します。

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

パラメーター

戻り値

グループを別のページとセクションに移動します。

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

パラメーター

戻り値

グループを別のセクションに移動します。

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

パラメーター

戻り値

プロセスの作業項目の種類の動作を削除します。

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

パラメーター

戻り値

作業項目フォームからコントロールを削除します。

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

パラメーター

戻り値

作業項目フォームからグループを削除します。

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

パラメーター

戻り値

作業項目フォームからページを削除します

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

パラメーター

戻り値

作業項目の種類からフィールドを削除します。 フィールドを完全に削除しません。

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

パラメーター

戻り値

プロセスの作業項目の種類の動作を更新します。

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

パラメーター

戻り値

作業項目フォームのコントロールを更新します。

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

パラメーター

戻り値

作業項目フォームでグループを更新します。

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

パラメーター

戻り値

リストを更新します。

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

パラメーター

戻り値

作業項目フォームのページを更新する

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

パラメーター

戻り値

プロセス内の動作を置き換えます。

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

パラメーター

戻り値

プロセスの作業項目の種類を更新します。

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

パラメーター

戻り値

プロセスの作業項目の種類にルールを更新します。

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

パラメーター

戻り値

プロセスの作業項目の種類に特定の状態定義を更新します。

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

パラメーター

戻り値

作業項目フォームにシステム コントロールを更新/追加します。

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

パラメーター

戻り値

作業項目タイプのフィールドを更新します。

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

パラメーター

戻り値