アクセス・グループ・ルールの更新
patch
/crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}
リクエスト
パス・パラメータ
- RuleNumber(required): string
ルールのルール番号。 ユーザーは、この値を指定することも、システム生成の番号を指定することもできます。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
AccessGroupCandidate: array Access Group Rule Candidates
タイトル:
Access Group Rule Candidates
アクセス・グループ・ルール候補リソースは、アクセス・グループ候補の表示、作成、更新および削除に使用されます。 ルールに関連付けられたアクセス・グループ・レコードを提供します。 -
AccessGroupCondition: array Access Group Rule Conditions
タイトル:
Access Group Rule Conditions
アクセス・グループ条件リソースは、グループ・ルール条件の表示、作成、更新および削除に使用されます。 これらはルールに関連付けられた条件です。 -
ActiveFlag: boolean
タイトル:
Active
最大長:1
デフォルト値:false
アクセス・グループ・ルールがアクティブかどうかを示します。 -
ConditionCode: string
タイトル:
Condition Code
最大長:240
事前定義済ルールのコード。 ハイブリッド・ルールにのみ適用されます。 -
Description: string
タイトル:
Rule Description
最大長:255
ルールの説明。 -
MatchingType: string
タイトル:
Matching Type
最大長:30
条件の一致タイプ(OR/AND)。 -
Object: string
タイトル:
Object
最大長:75
このルールを作成する必要があるオブジェクト名。 -
PredefinedFlag: boolean
タイトル:
Predefined
最大長:1
デフォルト値:false
ルールがシード済かユーザー定義かを示します。 -
RuleName: string
タイトル:
Rule Name
最大長:200
ルールの表示名。
ネストされたスキーマ : アクセス・グループ・ルール候補
タイプ:
array
タイトル:
Access Group Rule Candidates
アクセス・グループ・ルール候補リソースは、アクセス・グループ候補の表示、作成、更新および削除に使用されます。 ルールに関連付けられたアクセス・グループ・レコードを提供します。
ソースを表示
ネストされたスキーマ : アクセス・グループ・ルール条件
タイプ:
array
タイトル:
Access Group Rule Conditions
アクセス・グループ条件リソースは、グループ・ルール条件の表示、作成、更新および削除に使用されます。 これらはルールに関連付けられた条件です。
ソースを表示
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
AccessLevel: string
タイトル:
Access Level
最大長:255
デフォルト値:READ
ルールに関連付けられたアクセス・レベル。 -
EnableFlag: boolean
タイトル:
Enable
最大長:1
アクセス・グループの候補者がこのルールに対して使用可能かどうかを示します。
ネストされたスキーマ : accessGroupRules-AccessGroupCondition-item-patch-request
タイプ:
ソースを表示
object
-
Object: string
タイトル:
Object
最大長:64
ルール条件の作成が必要なオブジェクト。 -
ObjectAttributeCode: string
タイトル:
Object Attribute Code
最大長:80
ルール条件の作成が必要な属性。 -
Operator: string
タイトル:
Operator
最大長:20
属性に適用可能な演算子。 IN演算子およびNOT IN演算子の更新は許可されていません。 既存のレコードを削除し、IN演算子とNOT IN演算子の新しいレコードを作成する必要があります。 -
Value: string
タイトル:
Value
最大長:255
条件の値。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : accessGroupRules-item-response
タイプ:
ソースを表示
object
-
AccessGroupCandidate: array Access Group Rule Candidates
タイトル:
Access Group Rule Candidates
アクセス・グループ・ルール候補リソースは、アクセス・グループ候補の表示、作成、更新および削除に使用されます。 ルールに関連付けられたアクセス・グループ・レコードを提供します。 -
AccessGroupCondition: array Access Group Rule Conditions
タイトル:
Access Group Rule Conditions
アクセス・グループ条件リソースは、グループ・ルール条件の表示、作成、更新および削除に使用されます。 これらはルールに関連付けられた条件です。 -
ActiveFlag: boolean
タイトル:
Active
最大長:1
デフォルト値:false
アクセス・グループ・ルールがアクティブかどうかを示します。 -
ConditionCode: string
タイトル:
Condition Code
最大長:240
事前定義済ルールのコード。 ハイブリッド・ルールにのみ適用されます。 -
ConditionName: string
タイトル:
Condition
読取り専用:true
最大長:1000
事前定義済ルールの条件名。 ハイブリッド・ルールにのみ適用されます。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
ルールを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
ルールが作成された日付。 -
DeleteFlag: boolean
タイトル:
Delete
読取り専用:true
ルールを削除できるかどうかを示します。 -
Description: string
タイトル:
Rule Description
最大長:255
ルールの説明。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
ルールが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
ルールを最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MatchingType: string
タイトル:
Matching Type
最大長:30
条件の一致タイプ(OR/AND)。 -
Object: string
タイトル:
Object
最大長:75
このルールを作成する必要があるオブジェクト名。 -
ObjectCode: string
タイトル:
Object Code
読取り専用:true
最大長:75
このルールを作成する必要があるオブジェクト・コード。 -
PredefinedFlag: boolean
タイトル:
Predefined
最大長:1
デフォルト値:false
ルールがシード済かユーザー定義かを示します。 -
RuleId: integer (int64)
タイトル:
Rule ID
ルールの一意の識別子。 -
RuleName: string
タイトル:
Rule Name
最大長:200
ルールの表示名。 -
RuleNumber: string
タイトル:
Rule Number
最大長:30
ルールのルール番号。 ユーザーは、この値を指定することも、システム生成の番号を指定することもできます。 -
UpdateFlag: boolean
タイトル:
Update
読取り専用:true
ルールを更新できるかどうかを示します。
ネストされたスキーマ : アクセス・グループ・ルール候補
タイプ:
array
タイトル:
Access Group Rule Candidates
アクセス・グループ・ルール候補リソースは、アクセス・グループ候補の表示、作成、更新および削除に使用されます。 ルールに関連付けられたアクセス・グループ・レコードを提供します。
ソースを表示
ネストされたスキーマ : アクセス・グループ・ルール条件
タイプ:
array
タイトル:
Access Group Rule Conditions
アクセス・グループ条件リソースは、グループ・ルール条件の表示、作成、更新および削除に使用されます。 これらはルールに関連付けられた条件です。
ソースを表示
ネストされたスキーマ : accessGroupRules-AccessGroupCandidate-item-response
タイプ:
ソースを表示
object
-
AccessGroupName: string
タイトル:
Access Group Name
読取り専用:true
最大長:4000
アクセス・グループ候補の名前。 -
AccessGroupNumber: string
タイトル:
Access Group Number
読取り専用:true
最大長:4000
このルールに関連付けられているアクセス・グループ番号。 -
AccessLevel: string
タイトル:
Access Level
最大長:255
デフォルト値:READ
ルールに関連付けられたアクセス・レベル。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
グループ候補を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
グループ候補者が作成された日付。 -
DeleteFlag: boolean
タイトル:
Delete
読取り専用:true
候補者を削除できるかどうかを示します。 -
EnableFlag: boolean
タイトル:
Enable
最大長:1
アクセス・グループの候補者がこのルールに対して使用可能かどうかを示します。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
グループ候補者が最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
グループ候補を最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PredefinedFlag: boolean
タイトル:
Predefined
読取り専用:true
アクセス・グループ候補がシードされているかどうかを示します。 -
RuleCandidateId: integer (int64)
タイトル:
Rule Candidate ID
ルール候補の一意の識別子。 -
RuleCandidateNumber: string
タイトル:
Rule Candidate Number
最大長:30
アクセス・グループ・ルール候補の内部番号。 -
RuleNumber: string
タイトル:
Rule Number
読取り専用:true
最大長:30
このアクセス・グループ候補が属するルール番号。 -
UpdateFlag: boolean
タイトル:
Update
読取り専用:true
候補者を更新できるかどうかを示します。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
href: string
タイトル:
hyperlink reference
関連リソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連リソースの種類。 -
name: string
タイトル:
name
関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : accessGroupRules-AccessGroupCondition-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
グループ条件を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
グループ条件が作成された日付。 -
DeleteFlag: boolean
タイトル:
Delete
読取り専用:true
グループ条件を削除できるかどうかを示します。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
グループ条件が最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
グループ条件を最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Object: string
タイトル:
Object
最大長:64
ルール条件の作成が必要なオブジェクト。 -
ObjectAttributeCode: string
タイトル:
Object Attribute Code
最大長:80
ルール条件の作成が必要な属性。 -
ObjectAttributeName: string
タイトル:
Object Attribute Name
読取り専用:true
条件の作成が必要なオブジェクト属性の表示名。 -
ObjectCode: string
タイトル:
Object Code
読取り専用:true
最大長:75
ルール条件の作成が必要なオブジェクト・コード。 -
Operator: string
タイトル:
Operator
最大長:20
属性に適用可能な演算子。 IN演算子およびNOT IN演算子の更新は許可されていません。 既存のレコードを削除し、IN演算子とNOT IN演算子の新しいレコードを作成する必要があります。 -
RuleConditionNumber: string
タイトル:
Rule Condition Number
最大長:30
ルール条件番号。 -
RuleNumber: string
タイトル:
Rule Number
読取り専用:true
最大長:30
条件を作成する必要があるルール番号。 -
UpdateFlag: boolean
タイトル:
Update
読取り専用:true
グループ条件を更新できるかどうかを示します。 -
Value: string
タイトル:
Value
最大長:255
条件の値。
リンク
- AccessGroupCandidate
-
パラメータ:
- RuleNumber:
$request.path.RuleNumber
アクセス・グループ・ルール候補リソースは、アクセス・グループ候補の表示、作成、更新および削除に使用されます。 ルールに関連付けられたアクセス・グループ・レコードを提供します。 - RuleNumber:
- AccessGroupCondition
-
パラメータ:
- RuleNumber:
$request.path.RuleNumber
アクセス・グループ条件リソースは、グループ・ルール条件の表示、作成、更新および削除に使用されます。 これらはルールに関連付けられた条件です。 - RuleNumber:
- deleteAndPublishRule
-
パラメータ:
- RuleNumber:
$request.path.RuleNumber
プロファイル・オプションに基づいて、指定されたルールが削除され、その後MRAまたはOBRエンジンに公開されます。 - RuleNumber:
- isRulePublished
-
パラメータ:
- RuleNumber:
$request.path.RuleNumber
ルールPUIDに基づいて、ルールが公開されるとアクションが戻されます。 - RuleNumber:
- publishRule
-
パラメータ:
- RuleNumber:
$request.path.RuleNumber
プロファイル・オプションに基づいて、指定されたルールがMRAまたはOBRエンジンに公開されます。 - RuleNumber: