Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

webアクティビティ・ルール条件の取得

get

/crmRestApi/resources/11.13.18.05/webActivityRules/{WebActivityRuleNumber}/child/WebActivityRuleCondition/{WebActyRuleCondId}

リクエスト

パス・パラメータ

WebActivityRuleNumber(required): string

webアクティビティ・ルールの公開一意識別子。
WebActyRuleCondId(required): integer(int64)

webアクティビティ・ルール条件の一意の識別子。

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : 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アクティビティ・ルール条件の公開一意識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The resource user who last updated the web activity rule condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleConditionGroupName":{
            "title":"Condition Group Name",
            "maxLength":30,
            "type":"string",
            "description":"The rule condition group of the web activity rule condition.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Created Date",
            "type":"string",
            "description":"The date and time when the web activity rule condition is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WebActyRuleCondNumber":{
            "title":"Web Activity Rule Condition Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the web activity rule condition.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceObject":{
            "title":"Source Object",
            "maxLength":30,
            "type":"string",
            "description":"The source object of the web activity rule condition. The condition is defined using the attributes of the source object.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The resource user who created the web activity rule condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WebActyRuleCondId":{
            "title":"Web Activity Rule Condition ID",
            "type":"integer",
            "description":"The unique identifier of the web activity rule condition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RuleConditionExpression":{
            "title":"Condition Expression",
            "type":"string",
            "description":"The expression of the rule condition group of the web activity rule condition.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "RuleConditionGroupType":{
            "title":"Condition Group Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the rule condition group of the web activity rule condition.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The object version number of the web activity rule condition.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WebActivityRuleId":{
            "title":"Web Activity Rule ID",
            "type":"integer",
            "description":"The unique identifier of the web activity rule of the web activity rule condition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the web activity rule condition is last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":32,
            "type":"string",
            "description":"The login associated with the user who last updated the web activity rule condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、webアクティビティ・ルール条件を取得する方法を示しています。

curl -u <username:password> \ -X GET -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/webActivityRules/300100553880757/child/WebActivityRuleCondition/300100553880759

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
    "WebActyRuleCondId": "300100553880759",
    "WebActyRuleCondNumber": "300100553880759",
    "WebActivityRuleId": "300100553880757",
    "SourceObject": "WebActivity",
    "RuleConditionGroupName": "Group 1",
    "RuleConditionGroupType": "EXCLUSION",
    "CreationDate": "2022-04-27T08:44:06+00:00",
    "CreatedBy": "SALES_ADMIN",
    "LastUpdateDate": "2022-04-27T08:47:39.492+00:00",
    "LastUpdatedBy": "SALES_ADMIN",
    "LastUpdateLogin": "DD64F7343B630F2BE053D711F10A8F33",
    "ObjectVersionNumber": 2,
    "@context": {
        "key": "300100553880759",
        "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
        },
        "links": [
            {
                "rel": "self",
                "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/webActivityRules/300100553880757/child/WebActivityRuleCondition/300100553880759",
                "name": "WebActivityRuleCondition",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/webActivityRules/300100553880757/child/WebActivityRuleCondition/300100553880759",
                "name": "WebActivityRuleCondition",
                "kind": "item"
            },
            {
                "rel": "parent",
                "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/webActivityRules/300100553880757",
                "name": "webActivityRules",
                "kind": "item"
            },
            {
                "rel": "enclosure",
                "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/webActivityRules/300100553880757/child/WebActivityRuleCondition/300100553880759/enclosure/RuleConditionExpression",
                "name": "RuleConditionExpression",
                "kind": "other"
            }
        ]
    }
}

「トップに戻る」