WorkItemTrackingProcessRestClient class

パッケージ:

azure-devops-extension-api

VSS REST API への要求を行うために使用する (から派生する) 基本クラス

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)	指定されたプロセスで 1 つの動作を作成します。
createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)	プロセスで作業項目の種類を作成します。
createStateDefinition(WorkItemStateInputModel, string, string)	プロセスの作業項目の種類に状態定義を作成します。
deleteList(string)	候補リストを削除します。
deleteProcessBehavior(string, string)	プロセス内の動作を削除します。
deleteProcessById(string)	特定の ID のプロセスを削除します。
deleteProcessWorkItemType(string, string)	プロセス内の作業項目の種類を削除します。
deleteProcessWorkItemTypeRule(string, string, string)	プロセス内の作業項目の種類からルールを削除します。
deleteStateDefinition(string, string, string)	プロセスの作業項目の種類の状態定義を削除します。
deleteSystemControl(string, string, string)	作業項目フォームのシステム コントロールの変更を削除します。
editProcess(UpdateProcessModel, string)	特定の ID のプロセスを編集します。
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)	指定した ID の 1 つのプロセスを取得します。
getProcessWorkItemType(string, string, GetWorkItemTypeExpand)	プロセス内の 1 つの作業項目の種類を返します。
getProcessWorkItemTypeRule(string, string, string)	プロセスの作業項目の種類で 1 つのルールを返します。
getProcessWorkItemTypeRules(string, string)	プロセスの作業項目の種類内のすべてのルールの一覧を返します。
getProcessWorkItemTypes(string, GetWorkItemTypeExpand)	プロセス内のすべての作業項目の種類の一覧を返します。
getStateDefinition(string, string, string)	プロセスの作業項目の種類で 1 つの状態定義を返します。
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

プロセスの ID

witRefNameForBehaviors

string

動作の作業項目の種類の参照名

戻り値

Promise<WorkItemTypeBehavior>

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

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

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

パラメーター

field

AddProcessWorkItemTypeFieldRequest

processId

string

プロセスの ID。

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

プロセスの ID。

witRefName

string

作業項目の種類の参照名。

pageId

string

グループを追加するページの ID。

sectionId

string

グループを追加するセクションの ID。

戻り値

Promise<Group>

addPage(Page, string, string)

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

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

パラメーター

page

Page

ページ。

processId

string

プロセスの ID。

witRefName

string

作業項目の種類の参照名。

戻り値

Promise<Page>

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

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

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

パラメーター

processRuleCreate

CreateProcessRuleRequest

processId

string

プロセスの ID

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

プロセスの ID。

witRefName

string

作業項目の種類の参照名。

groupId

string

コントロールを追加するグループの ID。

戻り値

Promise<Control>

createList(PickList)

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

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

パラメーター

picklist

PickList

Picklist

戻り値

Promise<PickList>

createNewProcess(CreateProcessModel)

プロセスを作成します。

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

パラメーター

createRequest

CreateProcessModel

CreateProcessModel。

戻り値

Promise<ProcessInfo>

createProcessBehavior(ProcessBehaviorCreateRequest, string)

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

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

パラメーター

behavior

ProcessBehaviorCreateRequest

processId

string

プロセスの ID

戻り値

Promise<ProcessBehavior>

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

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

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

パラメーター

workItemType

CreateProcessWorkItemTypeRequest

processId

string

作業項目の種類を作成するプロセスの ID。

戻り値

Promise<ProcessWorkItemType>

createStateDefinition(WorkItemStateInputModel, string, string)

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

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

パラメーター

stateModel

WorkItemStateInputModel

processId

string

プロセスの ID

witRefName

string

作業項目の種類の参照名

戻り値

Promise<WorkItemStateResultModel>

deleteList(string)

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

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

パラメーター

listId

string

リストの ID

戻り値

Promise<void>

deleteProcessBehavior(string, string)

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

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

パラメーター

processId

string

プロセスの ID

behaviorRefName

string

動作の参照名

戻り値

Promise<void>

deleteProcessById(string)

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

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

パラメーター

processTypeId

string

戻り値

Promise<void>

deleteProcessWorkItemType(string, string)

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

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

パラメーター

processId

string

プロセスの ID。

witRefName

string

作業項目の種類の参照名。

戻り値

Promise<void>

deleteProcessWorkItemTypeRule(string, string, string)

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

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

パラメーター

processId

string

プロセスの ID

witRefName

string

作業項目の種類の参照名

ruleId

string

ルールの ID

戻り値

Promise<void>

deleteStateDefinition(string, string, string)

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

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

パラメーター

processId

string

プロセスの ID

witRefName

string

作業項目の種類の参照名

stateId

string

状態の ID

戻り値

Promise<void>

deleteSystemControl(string, string, string)

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

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

パラメーター

processId

string

プロセスの ID。

witRefName

string

作業項目の種類の参照名。

controlId

string

コントロールの ID。

戻り値

Promise<Control[]>

editProcess(UpdateProcessModel, string)

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

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

プロセスの ID。

witRefName

string

作業項目の種類の参照名。

戻り値

Promise<ProcessWorkItemTypeField[]>

getBehaviorForWorkItemType(string, string, string)

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

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

パラメーター

processId

string

プロセスの ID

witRefNameForBehaviors

string

動作の作業項目の種類の参照名

behaviorRefName

string

動作の参照名

戻り値

Promise<WorkItemTypeBehavior>

getBehaviorsForWorkItemType(string, string)

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

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

パラメーター

processId

string

プロセスの ID

witRefNameForBehaviors

string

動作の作業項目の種類の参照名

戻り値

Promise<WorkItemTypeBehavior[]>

getFormLayout(string, string)

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

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

パラメーター

processId

string

プロセスの ID。

witRefName

string

作業項目の種類の参照名。

戻り値

Promise<FormLayout>

getList(string)

候補リストを返します。

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

パラメーター

listId

string

リストの ID

戻り値

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

プロセスの ID

behaviorRefName

string

動作の参照名

expand

GetBehaviorsExpand

戻り値

Promise<ProcessBehavior>

getProcessBehaviors(string, GetBehaviorsExpand)

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

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

パラメーター

processId

string

プロセスの ID

expand

GetBehaviorsExpand

戻り値

Promise<ProcessBehavior[]>

getProcessByItsId(string, GetProcessExpandLevel)

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

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

パラメーター

processTypeId

string

expand

GetProcessExpandLevel

戻り値

Promise<ProcessInfo>

getProcessWorkItemType(string, string, GetWorkItemTypeExpand)

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

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

パラメーター

processId

string

プロセスの ID

witRefName

string

作業項目の種類の参照名

expand

GetWorkItemTypeExpand

返す作業項目の種類のプロパティを決定するフラグ

戻り値

Promise<ProcessWorkItemType>

getProcessWorkItemTypeRule(string, string, string)

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

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

パラメーター

processId

string

プロセスの ID

witRefName

string

作業項目の種類の参照名

ruleId

string

ルールの ID

戻り値

Promise<ProcessRule>

getProcessWorkItemTypeRules(string, string)

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

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

パラメーター

processId

string

プロセスの ID

witRefName

string

作業項目の種類の参照名

戻り値

Promise<ProcessRule[]>

getProcessWorkItemTypes(string, GetWorkItemTypeExpand)

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

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

パラメーター

processId

string

プロセスの ID

expand

GetWorkItemTypeExpand

返す作業項目の種類のプロパティを決定するフラグ

戻り値

Promise<ProcessWorkItemType[]>

getStateDefinition(string, string, string)

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

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

パラメーター

processId

string

プロセスの ID

witRefName

string

作業項目の種類の参照名

stateId

string

状態の ID

戻り値

Promise<WorkItemStateResultModel>

getStateDefinitions(string, string)

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

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

パラメーター

processId

string

プロセスの ID

witRefName

string

作業項目の種類の参照名

戻り値

Promise<WorkItemStateResultModel[]>

getSystemControls(string, string)

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

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

パラメーター

processId

string

プロセスの ID。

witRefName

string

作業項目の種類の参照名。

戻り値

Promise<Control[]>

getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)

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

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

パラメーター

processId

string

プロセスの ID。

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

プロセスの ID

witRefName

string

作業項目の種類の参照名

stateId

string

状態の ID

戻り値

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

プロセスの ID。

witRefName

string

作業項目の種類の参照名。

groupId

string

コントロールの移動先のグループの ID。

controlId

string

コントロールの ID。

removeFromGroupId

string

コントロールを削除するグループ ID。

戻り値

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

プロセスの ID。

witRefName

string

作業項目の種類の参照名。

pageId

string

グループが含まれるページの ID。

sectionId

string

グループが i.n のセクションの ID

groupId

string

グループの ID。

removeFromPageId

string

グループを削除するページの ID。

removeFromSectionId

string

グループを削除するセクションの ID。

戻り値

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

プロセスの ID。

witRefName

string

作業項目の種類の参照名。

pageId

string

グループが含まれるページの ID。

sectionId

string

グループが含まれているセクションの ID。

groupId

string

グループの ID。

removeFromSectionId

string

グループを削除するセクションの ID。

戻り値

Promise<Group>

removeBehaviorFromWorkItemType(string, string, string)

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

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

パラメーター

processId

string

プロセスの ID

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

プロセスの ID。

witRefName

string

作業項目の種類の参照名。

groupId

string

グループの ID。

controlId

string

削除するコントロールの ID。

戻り値

Promise<void>

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

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

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

パラメーター

processId

string

プロセスの ID

witRefName

string

作業項目の種類の参照名

pageId

string

グループが含まれるページの ID

sectionId

string

グループに対するセクションの ID は、

groupId

string

グループの ID

戻り値

Promise<void>

removePage(string, string, string)

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

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

パラメーター

processId

string

プロセスの ID

witRefName

string

作業項目の種類の参照名

pageId

string

ページの ID

戻り値

Promise<void>

removeWorkItemTypeField(string, string, string)

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

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

パラメーター

processId

string

プロセスの ID。

witRefName

string

作業項目の種類の参照名。

fieldRefName

string

フィールドの参照名。

戻り値

Promise<void>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

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

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

パラメーター

behavior

WorkItemTypeBehavior

processId

string

プロセスの ID

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

プロセスの ID。

witRefName

string

作業項目の種類の参照名。

groupId

string

グループの ID。

controlId

string

コントロールの ID。

戻り値

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

プロセスの ID。

witRefName

string

作業項目の種類の参照名。

pageId

string

グループが含まれるページの ID。

sectionId

string

グループが含まれているセクションの ID。

groupId

string

グループの ID。

戻り値

Promise<Group>

updateList(PickList, string)

リストを更新します。

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

パラメーター

picklist

PickList

listId

string

リストの ID

戻り値

Promise<PickList>

updatePage(Page, string, string)

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

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

パラメーター

page

Page

ページ

processId

string

プロセスの ID

witRefName

string

作業項目の種類の参照名

戻り値

Promise<Page>

updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)

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

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

パラメーター

behaviorData

ProcessBehaviorUpdateRequest

processId

string

プロセスの ID

behaviorRefName

string

動作の参照名

戻り値

Promise<ProcessBehavior>

updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)

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

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

パラメーター

workItemTypeUpdate

UpdateProcessWorkItemTypeRequest

processId

string

プロセスの ID

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

プロセスの ID

witRefName

string

作業項目の種類の参照名

ruleId

string

ルールの ID

戻り値

Promise<ProcessRule>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

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

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

パラメーター

stateModel

WorkItemStateInputModel

processId

string

プロセスの ID

witRefName

string

作業項目の種類の参照名

stateId

string

状態の ID

戻り値

Promise<WorkItemStateResultModel>

updateSystemControl(Control, string, string, string)

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

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

パラメーター

control

Control

processId

string

プロセスの ID。

witRefName

string

作業項目の種類の参照名。

controlId

string

コントロールの ID。

戻り値

Promise<Control>

updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)

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

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

パラメーター

field

UpdateProcessWorkItemTypeFieldRequest

processId

string

プロセスの ID。

witRefName

string

作業項目の種類の参照名。

fieldRefName

string

フィールドの参照名。

戻り値

Promise<ProcessWorkItemTypeField>