Rules - Add

リファレンス

サービス:: Work Item Tracking Process

API バージョン:: 7.1

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

POST https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/rules?api-version=7.1

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前。
processId	path	True	string (uuid)	プロセスの ID
witRefName	path	True	string	作業項目の種類の参照名
api-version	query	True	string	使用する API のバージョン。このバージョンの API を使用するには、これを '7.1' に設定する必要があります。

要求本文

名前	型	説明
actions	RuleAction[]	ルールがトリガーされたときに実行するアクションの一覧。
conditions	RuleCondition[]	ルールをトリガーする必要がある条件の一覧。
isDisabled	boolean	ルールが無効かどうかを示します。
name	string	ルールの名前。

応答

名前	型	説明
200 OK	ProcessRule	成功した操作

セキュリティ

oauth2

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン URL): https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

スコープ

名前	説明
vso.work_write	作業項目とクエリの読み取り、作成、更新、ボードメタデータの更新、領域の読み取り、反復パスに関連するメタデータの追跡、クエリの実行、サービスフックを介した作業項目イベントに関する通知の受信を行う機能を付与します。

例

Add the rule definition

要求のサンプル

HTTP

POST https://dev.azure.com/fabrikam/_apis/work/processes/{processId}/workItemTypes/{witRefName}/rules?api-version=7.1

{
  "name": "myRule",
  "conditions": [
    {
      "conditionType": "$when",
      "field": "Microsoft.VSTS.Common.Priority",
      "value": "1"
    },
    {
      "conditionType": "$when",
      "field": "System.State",
      "value": "Active"
    }
  ],
  "actions": [
    {
      "actionType": "$copyValue",
      "targetField": "Microsoft.VSTS.Common.Severity",
      "value": "1 - Critical"
    }
  ],
  "isDisabled": true
}

応答のサンプル

状態コード:: 200

{
  "id": "238ea945-a184-47f1-b458-9f858e9e552f",
  "name": "myRule",
  "conditions": [
    {
      "conditionType": "$when",
      "field": "Microsoft.VSTS.Common.Priority",
      "value": "1"
    },
    {
      "conditionType": "$when",
      "field": "System.State",
      "value": "Active"
    }
  ],
  "actions": [
    {
      "actionType": "$copyValue",
      "targetField": "Microsoft.VSTS.Common.Severity",
      "value": "1 - Critical"
    }
  ],
  "isDisabled": true,
  "customizationType": "custom",
  "url": "https://dev.azure.com/fabrikam/_apis/work/processes/0e3d68ff-fb7f-4736-b2ce-4d677b5559bc/workItemTypes/ScrumInherited.Bug/rules/238ea945-a184-47f1-b458-9f858e9e552f"
}

定義

名前	説明
CreateProcessRuleRequest	作業項目の種類に対してルールを作成するためのオブジェクト/クラスを要求します。
CustomizationType	この作業項目のカスタマイズの種類を示します。システムの動作は親プロセスから継承されますが、変更されません。継承された動作は、親プロセスから継承された変更された動作です。カスタム動作は、現在のプロセスでユーザーによって作成される動作です。
ProcessRule	プロセスルールの応答。
RuleAction	ルールがトリガーされたときに実行するアクション。
RuleActionType	ルールがトリガーされたときに実行するアクションの種類。
RuleCondition	ルールをトリガーする必要があるフィールドの条件を定義します。
RuleConditionType	条件の種類。 $When。この条件により、別のフィールドが特定の値を持つ場合、つまり、参照されるフィールドの Is 値が指定されたリテラル値と等しい場合に、子の実行が制限されます。 $WhenNot.この条件では、別のフィールドに特定の値がない場合、つまり、参照されるフィールドの Is 値が指定されたリテラル値と等しくない場合に、子の実行が制限されます。 $WhenChanged.この条件では、別のフィールドが変更された場合、つまり、参照されるフィールドの Is 値がそのフィールドの Was 値と等しくない場合に、子の実行が制限されます。 $WhenNotChanged.この条件では、別のフィールドが変更されていない場合、つまり、参照されるフィールドの Is 値がそのフィールドの Was 値と等しい場合に、子の実行が制限されます。

CreateProcessRuleRequest

Object

作業項目の種類に対してルールを作成するためのオブジェクト/クラスを要求します。

名前	型	説明
actions	RuleAction[]	ルールがトリガーされたときに実行するアクションの一覧。
conditions	RuleCondition[]	ルールをトリガーする必要がある条件の一覧。
isDisabled	boolean	ルールが無効かどうかを示します。
name	string	ルールの名前。

CustomizationType

列挙

この作業項目のカスタマイズの種類を示します。システムの動作は親プロセスから継承されますが、変更されません。継承された動作は、親プロセスから継承された変更された動作です。カスタム動作は、現在のプロセスでユーザーによって作成される動作です。

値	説明
custom	新しく作成された workitemtype がカスタマイズされている場合、Customization-type は Custom です。
inherited	継承されたプロセスの既存の workitemtype がカスタマイズされている場合、Customization-type は継承されます。
system	カスタマイズの種類は、システムによって生成された workitemtype の場合は System です。

ProcessRule

Object

プロセスルールの応答。

名前	型	説明
actions	RuleAction[]	ルールがトリガーされたときに実行するアクションの一覧。
conditions	RuleCondition[]	ルールをトリガーする必要がある条件の一覧。
customizationType	CustomizationType	ルールがシステムによって生成されるか、ユーザーによって作成されるかを示します。
id	string (uuid)	ルールを一意に識別する ID。
isDisabled	boolean	ルールが無効かどうかを示します。
name	string	ルールの名前。
url	string	リソース URL。

RuleAction

Object

ルールがトリガーされたときに実行するアクション。

名前	型	説明
actionType	RuleActionType	ルールがトリガーされたときに実行するアクションの種類。
targetField	string	アクションを実行するフィールド。
value	string	アクションが実行されたら、ターゲットフィールドに適用する値。

RuleActionType

列挙

ルールがトリガーされたときに実行するアクションの種類。

値	説明
copyFromClock	クロックから値を設定します。
copyFromCurrentUser	現在のユーザーをターゲットフィールドに設定します。例: {"actionType":"$copyFromCurrentUser","targetField":"System.AssignedTo","value":""}。
copyFromField	指定したフィールドから値をコピーし、ターゲットフィールドに設定します。例: {actionType: "$copyFromField"、targetField: "System.AssignedTo"、value:"System.ChangedBy"}。ここでは、値が "System.ChangedBy" からコピーされ、"System.AssingedTo" フィールドに設定されます。
copyFromServerClock	現在の時刻を使用して、ターゲットフィールドの値を設定します。例: {actionType: "$copyFromServerClock",targetField: "System.CreatedDate", value: ""}
copyFromServerCurrentUser	現在のユーザーを使用して、ターゲットフィールドの値を設定します。
copyValue	ターゲットフィールドの値を指定された値に設定します。例: {actionType: "$copyValue",targetField: "ScrumInherited.mypicklist", value: "samplevalue"}
disallowValue	フィールドが特定の値に設定されないようにします。
hideTargetField	フォームのターゲットフィールドを非表示にします。これはサーバー側のみのアクションです。
makeReadOnly	ターゲットフィールドを読み取り専用にします。例: {"actionType":"$makeReadOnly","targetField":"Microsoft.VSTS.Common.Activity","value":""}
makeRequired	ターゲットフィールドを必須にします。例: {"actionType":"$makeRequired","targetField":"Microsoft.VSTS.Common.Activity","value":""}
setDefaultFromClock	サーバークロックからターゲットフィールドに既定値を設定します。これは、ユーザーが日付/時刻などのフィールドを作成し、既定値を使用する場合に使用されます。
setDefaultFromCurrentUser	ターゲットフィールドに既定の現在のユーザー値を設定します。これは、ユーザーが ID 型のフィールドを作成し、既定値を使用する場合に使用されます。
setDefaultFromField	既存のフィールドからターゲットフィールドに既定値を設定します。これを使用すると、既存のフィールド値を現在のフィールドに設定する必要があります。
setDefaultValue	ターゲットフィールドに既定値を設定します。これは、ユーザーが整数/文字列フィールドを作成し、このフィールドの既定値を設定する場合に使用されます。
setValueToEmpty	ターゲットフィールドの値を空に設定します。

RuleCondition

Object

ルールをトリガーする必要があるフィールドの条件を定義します。

名前	型	説明
conditionType	RuleConditionType	条件の種類。 $When。この条件により、別のフィールドが特定の値を持つ場合、つまり、参照されるフィールドの Is 値が指定されたリテラル値と等しい場合に、子の実行が制限されます。 $WhenNot.この条件では、別のフィールドに特定の値がない場合、つまり、参照されるフィールドの Is 値が指定されたリテラル値と等しくない場合に、子の実行が制限されます。 $WhenChanged.この条件では、別のフィールドが変更された場合、つまり、参照されるフィールドの Is 値がそのフィールドの Was 値と等しくない場合に、子の実行が制限されます。 $WhenNotChanged.この条件では、別のフィールドが変更されていない場合、つまり、参照されるフィールドの Is 値がそのフィールドの Was 値と等しい場合に、子の実行が制限されます。
field	string	条件を定義するフィールド。
value	string	ルールの条件を定義するフィールドの値。

RuleConditionType

列挙

条件の種類。 $When。この条件により、別のフィールドが特定の値を持つ場合、つまり、参照されるフィールドの Is 値が指定されたリテラル値と等しい場合に、子の実行が制限されます。 $WhenNot.この条件では、別のフィールドに特定の値がない場合、つまり、参照されるフィールドの Is 値が指定されたリテラル値と等しくない場合に、子の実行が制限されます。 $WhenChanged.この条件では、別のフィールドが変更された場合、つまり、参照されるフィールドの Is 値がそのフィールドの Was 値と等しくない場合に、子の実行が制限されます。 $WhenNotChanged.この条件では、別のフィールドが変更されていない場合、つまり、参照されるフィールドの Is 値がそのフィールドの Was 値と等しい場合に、子の実行が制限されます。

値	説明
when	$When。この条件により、別のフィールドが特定の値を持つ場合、つまり、参照されるフィールドの Is 値が指定されたリテラル値と等しい場合に、子の実行が制限されます。
whenChanged	$WhenChanged.この条件では、別のフィールドが変更された場合、つまり、参照されるフィールドの Is 値がそのフィールドの Was 値と等しくない場合に、子の実行が制限されます。
whenCurrentUserIsMemberOfGroup
whenCurrentUserIsNotMemberOfGroup
whenNot	$WhenNot.この条件では、別のフィールドに特定の値がない場合、つまり、参照されるフィールドの Is 値が指定されたリテラル値と等しくない場合に、子の実行が制限されます。
whenNotChanged	$WhenNotChanged.この条件では、別のフィールドが変更されていない場合、つまり、参照されるフィールドの Is 値がそのフィールドの Was 値と等しい場合に、子の実行が制限されます。
whenStateChangedFromAndTo
whenStateChangedTo
whenValueIsDefined
whenValueIsNotDefined
whenWas
whenWorkItemIsCreated