機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 営業リード
  4. 製品

すべての製品の取得

get

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/products

リクエスト

パス・パラメータ
  • これは、営業リード・リソースの複合キーを構成し、営業リードのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、営業リードの特定のインスタンスに移動してハッシュ・キーを取得するために、営業リード・コレクション・リソースを問い合せる必要があります。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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 : 指定した在庫品目識別子および在庫組織識別子に基づいて製品を検索します。
      ファインダ変数:
      • InvOrgId; integer;在庫組織の一意の識別子。
      • InventoryItemId; integer;在庫品目の一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CSSEnabled; string;製品がCustomer Self Service (CSS)で有効かどうかを示します。 顧客セルフサービス・ポータルを使用して表示できるのは、CSSに対して有効な製品のみです。
    • 説明;文字列;製品の簡単な説明。
    • LongDescription; string;製品の詳細な説明。
    • ProductNum; string;製品の番号。
    • ProductType; string; アイテムや製品グループなど、製品のタイプ。
    • ServiceRequestEnabledCode; string; 関連付けられた製品に対してサービス・リクエストが有効かどうかを示すコード。
    • テキスト;文字列;製品に関連するテキストまたはキーワード。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : leads-products
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : leads-products-item-response
タイプ: object
ソースを表示
  • タイトル: Active
    読取り専用: true
    製品がアクティブかどうかを示します。 値がTrueの場合、製品はアクティブです。 デフォルト値はTrueです。
  • 読取り専用: true
    製品がCustomer Self Service (CSS)に対して使用可能かどうかを示します。 顧客セルフサービス・ポータルを使用して表示できるのは、CSSに対して有効な製品のみです。
  • タイトル: Name
    読取り専用: true
    最大長: 255
    製品の簡単な説明。
  • タイトル: Effective to Date
    読取り専用: true
    製品が無効になる日付。
  • タイトル: Inventory Item ID
    読取り専用: true
    在庫品目の一意の識別子。
  • タイトル: Inventory Organization ID
    読取り専用: true
    在庫組織の一意の識別子。
  • タイトル: Last Updated Date
    読取り専用: true
    製品が最後に更新された日付。
  • Links
  • タイトル: Description
    読取り専用: true
    最大長: 4000
    製品の詳細な説明。
  • タイトル: Product Group ID
    読取り専用: true
    製品グループの一意の識別子。
  • タイトル: Product Number
    読取り専用: true
    製品の番号。
  • タイトル: Product Type
    読取り専用: true
    製品のタイプ(品目または製品グループなど)。
  • 読取り専用: true
    関連付けられた製品に対してサービス・リクエストが有効かどうかを示すコード。
  • タイトル: Effective from Date
    読取り専用: true
    製品がアクティブである開始日。
  • タイトル: Keyword
    製品に関連付けられているテキストまたはキーワード。
リンク
setSelectedProductGroupId
パラメータ:
  • leadsUniqID: $request.path.leadsUniqID
このメソッドでは、ユーザーが選択した製品グループを設定できます。
setUsageCode
パラメータ:
  • leadsUniqID: $request.path.leadsUniqID
製品の使用コードを設定します。
setUsageMode
パラメータ:
  • leadsUniqID: $request.path.leadsUniqID
製品の使用モードを設定します。
setUserSelectionForTM
パラメータ:
  • leadsUniqID: $request.path.leadsUniqID
このメソッドでは、ユーザー選択のテリトリ・フィルタを設定できます。
トップに戻る

例:

cURLコマンド

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行して、すべての製品を取得する方法を示しています。 

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/products

レスポンス本文の例

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

{
  "items": [
    {
      "Text": null,
      "Description": " OPN - World Applications - Certified Partner",
      "StartDate": null,
      "EndDate": null,
      "InventoryItemId": 999997500683977,
      "InvOrgId": 204,
      "ProductNum": "TG9",
      "LongDescription": null,
      "ProdGroupId": 999997826070843,
      "ActiveFlag": null,
      "LastUpdateDate": null,
      "ProductType": null,
      "ServiceRequestEnabledCode": null,
      "CSSEnabled": null,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/products/00020000000EACED0005770800038D7E0FCDF6C90000000EACED0005770800000000000000CC",
          "name": "products",
          "kind": "item"
        },
......
]
    },
.......
  ]
    }
  ],
  "count": 25,
  "hasMore": true,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/products",
      "name": "products",
      "kind": "Collection"
    }
  ]
}
「トップに戻る」