webアクティビティ・ルールの作成
post
/crmRestApi/resources/11.13.18.05/webActivityRules
リクエスト
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- Upsert-Mode:
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
ActiveFlag(required): boolean
タイトル:
Status
最大長:1
webアクティビティ・ルールがアクティブかどうかを示します。 -
Description: string
タイトル:
Description
最大長:1000
webアクティビティ・ルールの説明。 -
ObjectVersionNumber: 整数(int32)
タイトル:
Object Version Number
webアクティビティ・ルールのオブジェクト・バージョン番号。 -
WebActivityRuleCondition: array Web Activity Rule Conditions
タイトル:
Web Activity Rule Conditions
webアクティビティ・ルール条件リソースは、Webアクティビティ・ルール条件の表示、作成、更新および削除に使用されます。 -
WebActivityRuleId: integer (int64)
タイトル:
Web Activity Rule ID
webアクティビティ・ルールの一意の識別子。 -
WebActivityRuleName(required): string
タイトル:
Name
最大長:30
webアクティビティ・ルールの名前。 -
WebActivityRuleNumber: string
タイトル:
Web Activity Rule Number
最大長:30
webアクティビティ・ルールの公開一意識別子。 -
WebActivityType(required): string
タイトル:
Web Activity Type
最大長:100
webアクティビティ・ルールのWebアクティビティ・タイプ。
ネストされたスキーマ : Webアクティビティ・ルール条件
タイプ:
array
タイトル:
Web Activity Rule Conditions
webアクティビティ・ルール条件リソースは、Webアクティビティ・ルール条件の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
ObjectVersionNumber: 整数(int32)
タイトル:
Object Version Number
webアクティビティ・ルール条件のオブジェクト・バージョン番号。 -
RuleConditionExpression: 文字列(バイト)
タイトル:
Condition Expression
webアクティビティ・ルール条件のルール条件グループの式。 -
RuleConditionGroupName: string
タイトル:
Condition Group Name
最大長:30
webアクティビティ・ルール条件のルール条件グループ。 -
RuleConditionGroupType: string
タイトル:
Condition Group Type
最大長:30
webアクティビティ・ルール条件のルール条件グループのタイプ。 -
SourceObject: string
タイトル:
Source Object
最大長:30
webアクティビティ・ルール条件のソース・オブジェクト。 条件は、ソース・オブジェクトの属性を使用して定義されます。 -
WebActivityRuleId: integer (int64)
タイトル:
Web Activity Rule ID
webアクティビティ・ルール条件におけるWebアクティビティ・ルールの一意の識別子。 -
WebActyRuleCondId: integer (int64)
タイトル:
Web Activity Rule Condition ID
webアクティビティ・ルール条件の一意の識別子。 -
WebActyRuleCondNumber: string
タイトル:
Web Activity Rule Condition Number
最大長:30
webアクティビティ・ルール条件の公開一意識別子。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : webActivityRules-item-response
タイプ:
ソースを表示
object
-
ActiveFlag: boolean
タイトル:
Status
最大長:1
webアクティビティ・ルールがアクティブかどうかを示します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
webアクティビティ・ルールを作成したリソース・ユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
webアクティビティ・ルールが作成された日時。 -
Description: string
タイトル:
Description
最大長:1000
webアクティビティ・ルールの説明。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
webアクティビティ・ルールが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
webアクティビティ・ルールを最後に更新したリソース・ユーザー。 -
LastUpdateLogin: string
タイトル:
Last Updated Login
読取り専用:true
最大長:32
webアクティビティ・ルールを最後に更新したユーザーに関連付けられたログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
タイトル:
Object Version Number
webアクティビティ・ルールのオブジェクト・バージョン番号。 -
StatusLookupCode: string
タイトル:
Status
読取り専用:true
最大長:30
webアクティビティ・ルールのステータスの参照コード。 -
StatusMeaning: string
タイトル:
Status
読取り専用:true
最大長:80
webアクティビティ・ルールのステータス内容。 -
WebActivityRuleCondition: array Web Activity Rule Conditions
タイトル:
Web Activity Rule Conditions
webアクティビティ・ルール条件リソースは、Webアクティビティ・ルール条件の表示、作成、更新および削除に使用されます。 -
WebActivityRuleId: integer (int64)
タイトル:
Web Activity Rule ID
webアクティビティ・ルールの一意の識別子。 -
WebActivityRuleName: string
タイトル:
Name
最大長:30
webアクティビティ・ルールの名前。 -
WebActivityRuleNumber: string
タイトル:
Web Activity Rule Number
最大長:30
webアクティビティ・ルールの公開一意識別子。 -
WebActivityType: string
タイトル:
Web Activity Type
最大長:100
webアクティビティ・ルールのWebアクティビティ・タイプ。 -
WebActivityTypeLookupCode: string
タイトル:
Web Activity Type
読取り専用:true
最大長:30
webアクティビティ・ルールのWebアクティビティ・タイプの参照コード。 -
WebActivityTypeMeaning: string
タイトル:
Web Activity Type
読取り専用:true
最大長:80
webアクティビティ・ルールのWebアクティビティ・タイプの意味。
ネストされたスキーマ : Webアクティビティ・ルール条件
タイプ:
array
タイトル:
Web Activity Rule Conditions
webアクティビティ・ルール条件リソースは、Webアクティビティ・ルール条件の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : webActivityRules-WebActivityRuleCondition-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
webアクティビティ・ルール条件を作成したリソース・ユーザー。 -
CreationDate: string (date-time)
タイトル:
Created Date
読取り専用:true
webアクティビティ・ルール条件が作成された日時。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
webアクティビティ・ルール条件が最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
webアクティビティ・ルール条件を最後に更新したリソース・ユーザー。 -
LastUpdateLogin: string
タイトル:
Last Updated Login
読取り専用:true
最大長:32
webアクティビティ・ルール条件を最後に更新したユーザーに関連付けられたログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
タイトル:
Object Version Number
webアクティビティ・ルール条件のオブジェクト・バージョン番号。 -
RuleConditionExpression: 文字列(バイト)
タイトル:
Condition Expression
webアクティビティ・ルール条件のルール条件グループの式。 -
RuleConditionGroupName: string
タイトル:
Condition Group Name
最大長:30
webアクティビティ・ルール条件のルール条件グループ。 -
RuleConditionGroupType: string
タイトル:
Condition Group Type
最大長:30
webアクティビティ・ルール条件のルール条件グループのタイプ。 -
SourceObject: string
タイトル:
Source Object
最大長:30
webアクティビティ・ルール条件のソース・オブジェクト。 条件は、ソース・オブジェクトの属性を使用して定義されます。 -
WebActivityRuleId: integer (int64)
タイトル:
Web Activity Rule ID
webアクティビティ・ルール条件におけるWebアクティビティ・ルールの一意の識別子。 -
WebActyRuleCondId: integer (int64)
タイトル:
Web Activity Rule Condition ID
webアクティビティ・ルール条件の一意の識別子。 -
WebActyRuleCondNumber: string
タイトル:
Web Activity Rule Condition Number
最大長:30
webアクティビティ・ルール条件の公開一意識別子。
リンク
- StatusLookupVA
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_WEB_ACT_RULE_STATUS
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: StatusLookupCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- WebActivityRuleCondition
-
パラメータ:
- WebActivityRuleNumber:
$request.path.WebActivityRuleNumber
webアクティビティ・ルール条件リソースは、Webアクティビティ・ルール条件の表示、作成、更新および削除に使用されます。 - WebActivityRuleNumber:
- WebActivityTypeLookupVA
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_WEB_ACT_TYPE
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: WebActivityTypeLookupCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
例:
次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行して、webアクティビティ・ルールを作成する方法を示しています。
curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/webActivityRules/
リクエスト本文の例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています。
{ "WebActivityRuleName":"Email Send Rule", "WebActivityType":"EmailSend", "Description":"Inactive Email Send Web Activity Rule", "ActiveFlag":"N" }
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "WebActivityRuleId": 300100592844203, "WebActivityRuleNumber": "300100592844203", "WebActivityRuleName": "Email Send Rule", "WebActivityType": "EmailSend", "Description": "Inactive Email Send Web Activity Rule", "ActiveFlag": false, "CreationDate": "2022-03-23T17:27:01+00:00", "CreatedBy": "SALES_ADMIN", "LastUpdateDate": "2022-03-23T17:27:01.178+00:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateLogin": "DAA07C7F63C6D124E053D711F10A9C8B", "ObjectVersionNumber": 1, "WebActivityTypeMeaning": null, "WebActivityTypeLookupCode": null, "StatusMeaning": null, "StatusLookupCode": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/webActivityRules/300100592844203", "name": "webActivityRules", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/webActivityRules/300100592844203", "name": "webActivityRules", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/webActivityRules/300100592844203/child/WebActivityRuleCondition", "name": "WebActivityRuleCondition", "kind": "collection" } ] }