WorkItemTrackingProcessDefinitionsRestClient class

パッケージ:

azure-devops-extension-api

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

Extends

RestClientBase

コンストラクター

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)	指定されたプロセスで 1 つの動作を作成します。
createField(FieldModel, string)	プロセス内に 1 つのフィールドを作成します。
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)	プロセス内の 1 つの動作を返します。
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)	プロセスの作業項目の種類の 1 つのフィールドを返します。
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)	特定のプロセスと作業項目の種類のスコープ内の 1 つのフィールドを更新します。

コンストラクターの詳細

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

プロセスの ID

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

プロセスの ID

witRefName

string

作業項目の種類の参照名

groupId

string

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

戻り値

Promise<Control>

addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)

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

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

パラメーター

field

WorkItemTypeFieldModel2

processId

string

プロセスの ID

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

プロセスの 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>

createBehavior(BehaviorCreateModel, string)

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

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

パラメーター

behavior

BehaviorCreateModel

processId

string

プロセスの ID

戻り値

Promise<BehaviorModel>

createField(FieldModel, string)

プロセス内に 1 つのフィールドを作成します。

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

パラメーター

field

FieldModel

processId

string

プロセスの ID

戻り値

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

プロセスの ID

witRefName

string

作業項目の種類の参照名

戻り値

Promise<WorkItemStateResultModel>

createWorkItemType(WorkItemTypeModel, string)

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

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

パラメーター

workItemType

WorkItemTypeModel

processId

string

プロセスの ID

戻り値

Promise<WorkItemTypeModel>

deleteBehavior(string, string)

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

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

パラメーター

processId

string

プロセスの ID

behaviorId

string

動作の ID

戻り値

Promise<void>

deleteList(string)

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

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

パラメーター

listId

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>

deleteWorkItemType(string, string)

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

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

パラメーター

processId

string

プロセスの ID

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

プロセスの ID

witRefName

string

作業項目の種類の参照名

groupId

string

グループの ID

controlId

string

コントロールの ID

戻り値

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

プロセスの ID

witRefName

string

作業項目の種類の参照名

pageId

string

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

sectionId

string

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

groupId

string

グループの ID

戻り値

Promise<Group>

editPage(Page, string, string)

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

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

パラメーター

page

Page

ページ

processId

string

プロセスの ID

witRefName

string

作業項目の種類の参照名

戻り値

Promise<Page>

getBehavior(string, string)

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

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

パラメーター

processId

string

プロセスの ID

behaviorId

string

動作の ID

戻り値

Promise<BehaviorModel>

getBehaviorForWorkItemType(string, string, string)

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

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

パラメーター

processId

string

プロセスの ID

witRefNameForBehaviors

string

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

behaviorRefName

string

動作の参照名

戻り値

Promise<WorkItemTypeBehavior>

getBehaviors(string)

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

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

パラメーター

processId

string

プロセスの ID

戻り値

Promise<BehaviorModel[]>

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<PickListModel>

パラメーター

listId

string

リストの ID

戻り値

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

プロセスの 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[]>

getWorkItemType(string, string, GetWorkItemTypeExpand)

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

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

パラメーター

processId

string

プロセスの ID

witRefName

string

作業項目の種類の参照名

expand

GetWorkItemTypeExpand

戻り値

Promise<WorkItemTypeModel>

getWorkItemTypeField(string, string, string)

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

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

パラメーター

processId

string

プロセスの ID

witRefNameForFields

string

フィールドの作業項目の種類参照名

fieldRefName

string

フィールドの参照名

戻り値

Promise<WorkItemTypeFieldModel2>

getWorkItemTypeFields(string, string)

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

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

パラメーター

processId

string

プロセスの ID

witRefNameForFields

string

フィールドの作業項目の種類参照名

戻り値

Promise<WorkItemTypeFieldModel2[]>

getWorkItemTypes(string, GetWorkItemTypeExpand)

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

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

パラメーター

processId

string

プロセスの ID

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

プロセスの ID

witRefName

string

作業項目の種類の参照名

stateId

string

状態の ID

戻り値

Promise<WorkItemStateResultModel>

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>

removeFieldFromWorkItemType(string, string, string)

プロセスの作業項目の種類のフィールドを削除します。

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

パラメーター

processId

string

プロセスの ID

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

プロセスの 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>

replaceBehavior(BehaviorReplaceModel, string, string)

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

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

パラメーター

behaviorData

BehaviorReplaceModel

processId

string

プロセスの ID

behaviorId

string

動作の ID

戻り値

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

プロセスの ID

witRefName

string

作業項目の種類の参照名

groupId

string

コントロールを移動するグループの ID

controlId

string

コントロールの ID

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

プロセスの ID

witRefName

string

作業項目の種類の参照名

pageId

string

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

sectionId

string

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

groupId

string

グループの ID

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

プロセスの ID

witRefName

string

作業項目の種類の参照名

pageId

string

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

sectionId

string

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

groupId

string

グループの ID

removeFromSectionId

string

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

戻り値

Promise<Group>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

更新プロセスの動作の既定の作業項目の種類です。

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

パラメーター

behavior

WorkItemTypeBehavior

processId

string

プロセスの ID

witRefNameForBehaviors

string

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

戻り値

Promise<WorkItemTypeBehavior>

updateField(FieldUpdate, string)

プロセス内の特定のフィールドを更新します。

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

パラメーター

field

FieldUpdate

processId

string

プロセスの ID

戻り値

Promise<FieldModel>

updateList(PickListModel, string)

リストを更新します。

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

パラメーター

picklist

PickListModel

listId

string

リストの ID

戻り値

Promise<PickListModel>

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>

updateWorkItemType(WorkItemTypeUpdateModel, string, string)

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

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

パラメーター

workItemTypeUpdate

WorkItemTypeUpdateModel

processId

string

プロセスの ID

witRefName

string

作業項目の種類の参照名

戻り値

Promise<WorkItemTypeModel>

updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)

特定のプロセスと作業項目の種類のスコープ内の 1 つのフィールドを更新します。

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

パラメーター

field

WorkItemTypeFieldModel2

フィールドを更新するモデル

processId

string

プロセスの ID

witRefNameForFields

string

フィールドの作業項目タイプ参照名

戻り値

Promise<WorkItemTypeFieldModel2>