機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのOracle CX SalesおよびB2B Service REST API for Sales and Fusion ServiceのREST API
  2. 適応型検索
  3. 適応型検索の例
  4. 検索の転記操作

検索の転記操作

このトピックでは、POSTメソッドを使用した検索の例をいくつか示します。

保存済問合せの問合せ(保存済検索)

次のペイロードでは、保存済問合せに基づく問合せ方法について説明します。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries

リクエスト・ペイロードの例

{   "entity":"Account",
    "copiedFrom":"https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries/{queryUuid}"
}

制限

エラスティック・サーバーから取得されたデータ行のリストを制約するための制限を指定します。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries

リクエスト・ペイロードの例

{   "entity":"Account",
    "copiedFrom":"https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries/{queryUuid}",
    "limit":3
}

オフセット

検索を開始する開始インデックスを指定します。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries

リクエスト・ペイロードの例

{   "entity":"Account",
    "copiedFrom":"https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries/{queryUuid}",
    "limit":3,
    "offset":10
}

リンク

データ行に表示するリンクのセットを指定するには、ページ区切りリンクがあればそのまま保持されることに注意してください。 また、ページ区切りを生成しない一時問合せであるため、ページ区切りリンクを無効化するために次のペイロードを混同しないでください。 ただし、問合せ結果プリファレンスの場合も同様です。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries

リクエスト・ペイロードの例

{   "entity":"Account",
    "copiedFrom":"https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries/{queryUuid}",
    "limit":3,
    "offset":10,
    "links":["canonical"]
}

リンクの除外

除外するリンクのセットを指定します。 ページ区切りリンク(そのまま保持されている場合)。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries

リクエスト・ペイロードの例

{   "entity":"Account",
    "copiedFrom":"https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries/{queryUuid}",
    "limit":3,
    "offset":10,
    "excludeLinks":["self","parent"]
}

リンクなし

データ行からのすべてのリンクを無効にします。 ページ区切りリンクはそのまま保持されます。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries

リクエスト・ペイロードの例

{   "entity":"Account",
    "copiedFrom":"https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries/{queryUuid}",
    "limit":3,
    "offset":10,
    "onlyData":true
}

Language

検索結果をローカライズする特定の言語を指定します。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries

リクエスト・ペイロードの例

{   "entity":"Account",
    "copiedFrom":"https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries/{queryUuid}",
    "limit":3,
    "offset":10,
    "language":"KO"
}

ソート

ソートするフィールドを指定します。 オプションはascおよびdescです。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries

リクエスト・ペイロードの例

{   "entity":"Account",
    "copiedFrom":"https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries/{queryUuid}",
    "limit":3,
    "offset":10,
    "sort": [{ "attribute":"PartyUniqueName","direction":"ascending"}]
}

フィールド

データをフィルタするフィールドのリストを指定するには。 *(asterisk)の使用を確認してください。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries

リクエスト・ペイロードの例

{   "entity":"Account",
    "copiedFrom":"https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries/{queryUuid}",
    "limit":3,
    "offset":10,
    "fields":["PartyUniqueName","Primary*"]
}

フィールドを除外

検索結果から一連のフィールドを除外します。 *(asterisk)の使用を確認してください。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries

リクエスト・ペイロードの例

{   "entity":"Account",
    "copiedFrom":"https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries/{queryUuid}",
    "limit":3,
    "offset":10,
    "excludeFields":["Primary*"]
}

キーワード

検索の基になるキーワードのセットを指定するには

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries

リクエスト・ペイロードの例

{   "entity":"Account",
    "limit":3,
    "keywords":"united,bengaluru"
}

日付バケットで検索

次のサンプルは、日付バケットで検索するためのペイロードを示しています。 日付では等しい演算子のみがサポートされます。 エラスティック検索RESTでサポートされている日付バケットについても読む: 日付バケット。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries

リクエスト・ペイロードの例

{  
    "entity" : "Account",
    "fields": ["PartyUniqueName","PrimaryAddress","CreationDate"],
    "q" : {"op": "$wi", "attribute": "CreationDate", "value1": "now-1y/y", "value2": "now"}
}

エンティティ全体の検索

キーワード

指定されたキーワードを持つエンティティ全体を検索する場合。 このプロトタイプでは、ソート、フィールドおよび除外フィールドはサポートされていません。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries

リクエスト・ペイロードの例

{
    "keywords":"test",
    "offset":90,
    "limit":3
}

エンティティ間

指定されたフィールドおよび除外フィールドを持つ特定のエンティティ・セットを検索します。 キーワードはグローバルであり、エンティティに固有ではないことに注意してください。 また、エンティティ間検索ではソートはサポートされていません。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries

リクエスト・ペイロードの例

{
    "keywords":"united",
    "offset":0,
    "entities":
    {  
        "Account":{
            "fields":["PartyUniqueName","PrimaryAddress"]
        },
        "Contact":{
            "fields":["PartyName","JobTitle"]
        }
    },
    "onlyData":true
}

最上位のネストされたエンティティの問合せ

この例は、最上位レベルでネストされたエンティティを検索する方法を示しています。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries?
リクエスト・ペイロードの例 
{
    "entity": "Activity",
    "limit": 10,
    "offset": 0,
    "fields": ["ActivityId"],
    "nestedEntities": {
        "ListOfContacts": {
            "limit": 10,
            "offset":0,
            "sort":[{ "attribute":"ListOfContacts.ContactId.PartyNumber","direction":"ascending"}]
        },
        "ListOfResourcesForTheTeam":{
             
        }
    },
    "q": {
        "op": "$or",
        "innerQuery":true,
        "criteria": [
            {
                "op": "$eq",
                "attribute": "ListOfContacts.ContactId.PrimaryAddress.State",
                "value":"CA"
            },
            {
                "op":"$eq",
                "attribute":"ListOfContacts.ContactId.PrimaryAddress.City",
                "value":"WESTMINSTER"
            }
        ]
    }
}

子レベルのネストされたエンティティの問合せ

この例は、子レベルでネストされたエンティティを検索する方法を示しています。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries?
リクエスト・ペイロードの例 
{
    "entity": "CRMProductGroup",
    "nestedEntities": {
        "ListOfProductGroupRelations.RelatedProductGroup.ListOfProductGroupRoots": {
            "limit": 10,
            "offset": 0
        }
    },
    "limit": 1,
    "offset": 2,
    "q": {
        "op": "$and",
        "innerQuery": true,
        "criteria": [
            {
                "op": "$eq",
                "attribute": "ListOfProductGroupRelations.RelatedProductGroup.ListOfProductGroupRoots.UsageCode",
                "value": "BASE"
            },
            {
                "op": "$eq",
                "attribute": "ListOfProductGroupRelations.RelatedProductGroup.ListOfProductGroupRoots.ActiveFlag",
                "value": false
            }
        ]
    }
}

第1レベル・リストの下にネストされた子レベルの問合せ

この例では、ネストされたエンティティを第1レベル・リストで検索する方法を示します。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries?
リクエスト・ペイロードの例 
{
    "entity": "Account",
    "limit": 1,
    "offset": 1,
    "nestedEntities": {
        "ListOfAddresses.ListOfPartySiteUses": {
            "limit": 1,
            "offset": 0
        }
    },
    "q": {
        "op": "$and",
        "innerQuery": true,
        "criteria": [
            {
                "op": "$eq",
                "attribute": "ListOfAddresses.ListOfPartySiteUses.SiteUseType",
                "value": "BILL_TO"
            }
        ]
    },
    "fields": [
        "PartyId"
    ]
}

複数のエンティティにわたるグローバル検索の実行

この例では、複数のエンティティを使用してグローバル検索を実行する方法を示します。

ノート:

エンティティ間で共通するフィールドがある場合、結果には複数のエンティティにまたがる追加のフィールドが含まれます。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/searchResources/11.13.18.05/custom-actions/queries?
リクエスト・ペイロードの例 
{
    "offset": 0,
    "entities": {
        "Account": {
            "nestedEntities": {
                "ListOfContacts": {
                    "limit": 4
                }
            },
            "fields": [
                "NumberOfContacts"
            ],
            "q": {
                "op": "$and",
                "innerQuery": true,
                "criteria": [
                    {
                        "op": "$pr",
                        "attribute": "ListOfContacts"
                    },
                    {
                        "op": "$gt",
                        "attribute": "NumberOfContacts",
                        "value": 10
                    }
                ]
            }
        },
        "Contact": {
            "fields":["PartyId"],
            "nestedEntities": {
                "ListOfPhones": {
                    "limit": 4
                }
            },
            "q": {
                "op": "$and",
                "innerQuery": true,
                "criteria": [
                    {
                        "op": "$eq",
                        "attribute": "ListOfPhones.PhoneType",
                        "value": "WORK"
                    }
                ]
            }
        }
    },
    "onlyData": true
}