機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. ユーザー関連アイテム

すべてのユーザー関連アイテムの取得

get

/crmRestApi/resources/11.13.18.05/userRelevantItems

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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 : 指定された主キーを持つ関連アイテムを検索します。
      ファインダ変数:
      • RelevantItemId; integer; ユーザーに関連付けられている関連アイテムの一意の識別子。
    • UserGuidAndObjectIdAltKey : 代替キーを持つ関連アイテムを検索します。
      ファインダ変数:
      • ObjectId; integer; オブジェクトの一意の識別子および主キー。
      • ObjectTypeCode; string;ビジネス・オブジェクトのオブジェクト・タイプ・コード。
      • UserGUID; string; リソースの代替の一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ObjectId; integer; オブジェクトの一意の識別子および主キー。
    • ObjectNumber; string;ビジネス・オブジェクトの公開一意識別子。
    • ObjectTypeCode; string;ビジネス・オブジェクトのオブジェクト・タイプ・コード。
    • RelevantItemId; integer; ユーザーに関連付けられている関連アイテムの一意の識別子。
    • UserGUID; string;ユーザーの一意の識別子。
    • UserPartyNumber; string;ユーザーのパーティ番号。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : userRelevantItems
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : userRelevantItems-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : ユーザー関連品目詳細
タイプ: array
タイトル: User Relevant Item Details
ユーザー関連品目詳細リソースは、ユーザーの関連品目に関する詳細を表示するために使用されます。
ソースを表示
ネストされたスキーマ : userRelevantItems-UserRelevantItemDetail-item-response
タイプ: object
ソースを表示
リンク
addToUserContext
このメソッドを使用すると、関連するすべてのアイテムをユーザー・コンテキストに追加できます。
refreshUserContext
このメソッドを使用すると、ユーザー・コンテキストのすべての関連アイテムをリフレッシュできます。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのユーザー関連アイテムを取得する方法を示しています。

cURLコマンド

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

レスポンス本文の例

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

{
    "items": [
        {
            "RelevantItemId": 300100186064807,
            "UserGUID": "352E980CE9686C4EF1E2CD35987EF86C",
            "UserPartyNumber": "100010037456865",
            "ObjectTypeCode": "Account",
            "Score": 148,
            "ObjectId": 300100186039341,
            "ObjectNumber": "CDRM_903991",
            "LastActivityDate": "2020-09-07T06:11:53+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/userRelevantItems/300100186064807",
                    "name": "userRelevantItems",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000001378"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/userRelevantItems/300100186064807",
                    "name": "userRelevantItems",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/userRelevantItems/300100186064807/child/UserRelevantItemDetail",
                    "name": "UserRelevantItemDetail",
                    "kind": "collection"
                }
            ]
        },
        {
            "RelevantItemId": 300100186130977,
            "UserGUID": "352E980CE9686C4EF1E2CD35987EF86C",
            "UserPartyNumber": "100010037456865",
            "ObjectTypeCode": "Account",
            "Score": 148,
            "ObjectId": 300100186130805,
            "ObjectNumber": "CDRM_906998",
            "LastActivityDate": "2020-09-07T13:20:38+00:00",
...
}
「トップに戻る」