機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. ユーザー・コンテキスト・オブジェクト・タイプ
  4. オブジェクト基準

すべてのオブジェクト基準の取得

get

/crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectCriteria

リクエスト

パス・パラメータ
  • 特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。 たとえば、取引先、担当者、見込み客などです。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

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

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey : SavedSearchUuidを使用してオブジェクト基準を検索します。
      ファインダ変数:
      • SavedSearchUuid; string;条件の保存済検索Uuid。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CreatedBy; string; 行を作成したユーザー。
    • CreationDate; string; 行が作成された日時。
    • 使用可能;文字列;保存済検索がユーザー・コンテキストに対して使用可能かどうかを示します。
    • LastUpdateDate; string; 行が最後に更新された日時。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; 行を最後に更新したユーザー。
    • MaximumFetchSize; integer; ユーザー・コンテキストに追加できる一致オブジェクトの最大数。
    • ObjectTypeCode; string; 特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。 たとえば、取引先、担当者、見込み客などです。
    • ObjectVersionNumber; integer; オプティミスティック・ロックの実装に使用される属性。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
    • SavedSearchUuid; string; ワークスペースで定義されている保存済Search(zca_es_saved_searches)のSavedSearchUUIDへの外部キー参照。
    • スコア、整数、保存済検索基準に定義されたベース・スコア。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : userContextObjectTypes-objectCriteria
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : userContextObjectTypes-objectCriteria-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    行を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    行が作成された日時。
  • タイトル: Enabled
    最大長: 1
    デフォルト値: Y
    保存済検索がユーザー・コンテキストに対して使用可能かどうかを示します。
  • タイトル: Last Update Date
    読取り専用: true
    行が最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    行を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Maximum Fetch Size
    デフォルト値: 5
    ユーザー・コンテキストに追加できる一致オブジェクトの最大数。
  • タイトル: Object Type Code
    最大長: 30
    特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。 たとえば、取引先、担当者、見込み客などです。
  • タイトル: Object Version Number
    デフォルト値: 1
    オプティミスティック・ロックの実装に使用される属性。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
  • タイトル: Saved Search JSON
    JSON形式の保存済検索基準パラメータ。
  • タイトル: Saved Search GUID
    最大長: 512
    ワークスペースで定義された保存済Search(zca_es_saved_searches)のSavedSearchUUIDへの外部キー参照。
  • タイトル: Score
    デフォルト値: 0
    保存検索条件に定義されたベース・スコア。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのオブジェクト基準を取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/userContextObjectTypes/Activity/child/objectCriteria

レスポンス本文の例

次に、JSON形式のレスポンス本文の内容を示します。

{
    "items": [
        {
            "SavedSearchUuid": "UC_SVSearch_Activity_01",
            "ObjectTypeCode": "Activity",
            "Score": 500,
            "MaximumFetchSize": 10,
            "CreatedBy": "SEED_DATA_FROM_APPLICATION",
            "CreationDate": "2020-09-05T18:21:59+00:00",
            "Enabled": "Y",
            "LastUpdateDate": "2020-09-20T20:25:24+00:00",
            "LastUpdateLogin": "AE7161BBAD8EAAAFE053DA0CF10AE976",
            "LastUpdatedBy": "SALES_ADMIN",
            "ObjectVersionNumber": 8,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/userContextObjectTypes/Activity/child/objectCriteria/UC_SVSearch_Activity_01",
                    "name": "objectCriteria",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000878"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/userContextObjectTypes/Activity/child/objectCriteria/UC_SVSearch_Activity_01",
                    "name": "objectCriteria",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/userContextObjectTypes/Activity",
                    "name": "userContextObjectTypes",
                    "kind": "item"
                },
                {
                    "rel": "enclosure",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/userContextObjectTypes/Activity/child/objectCriteria/UC_SVSearch_Activity_01/enclosure/SavedSearchJson",
                    "name": "SavedSearchJson",
                    "kind": "other"
                }
            ]
        },
        {
            "SavedSearchUuid": "UC_SVSearch_Activity_02",
            "ObjectTypeCode": "Activity",
            "Score": 500,
            "MaximumFetchSize": 10,
            "CreatedBy": "SEED_DATA_FROM_APPLICATION",
            "CreationDate": "2020-09-05T18:21:59.163+00:00",
            "Enabled": "Y",
            "LastUpdateDate": "2020-09-20T20:25:24+00:00",
            "LastUpdateLogin": "AE718D0FAEB1AAC6E053DA0CF10A1B5E",
            "LastUpdatedBy": "SALES_ADMIN",
            "ObjectVersionNumber": 6,
...
}
「トップに戻る」