機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 製品グループ

すべての製品グループの取得

get

/crmRestApi/resources/11.13.18.05/setupSalesCatalogs

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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 : 製品グループ識別子別に販売カタログを検索します。
      ファインダ変数:
      • ProdGrpDetailsId; integer;一意の製品グループ詳細識別子。
    • ProductGroupIdRowFinder : 製品グループ識別子別に販売カタログを検索します。
      ファインダ変数:
      • ProdGroupId; string;一意の製品グループ識別子。
    • ReferenceNumberRowFinder : 参照番号で販売カタログを検索します。
      ファインダ変数:
      • BindReferenceNumber; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AllowSelectionFlag; string; 製品グループを選択できるかどうかを示します。 有効な場合、値はY、それ以外の場合はNです。 防衛はY。
    • CreatedBy; string; 製品グループ・レコードを作成したユーザー。
    • CreationDate; string; レコードが作成された日時。
    • EndDate; string; 製品グループが非アクティブになる日時。
    • InternalName; string;製品グループの内部名。
    • LastUpdateDate; string; レコードが最後に更新された日付。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのセッション・ログイン。
    • LastUpdatedBy; string; 製品グループ・レコードを最後に更新したユーザー。
    • ModelConfigAttributes; string;製品のモデル構成。
    • ModelFamily; string;製品グループに関連付けられたモデル・ファミリの名前。
    • ModelLine; string;製品グループに関連付けられたモデル行の名前。
    • ModelName; string;製品グループのモデル名。
    • ObjectVersionNumber; integer;ロックの実装に使用される数値。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
    • ProdGroupDescription; string;実行時の表示に使用される翻訳済製品グループの説明。
    • ProdGroupId; integer;製品グループの一意の識別子。
    • ProdGroupName; string;実行時の表示に使用される製品グループの翻訳済名。
    • ProdGrpDetailsId; integer;製品グループ詳細の一意の識別子。
    • ProductGroupLockedBy; string;製品グループをロックしたユーザーの名前またはID。
    • ProductGroupLockedDate; string;製品グループがロックされた日付。
    • ProductGroupLockedFlag; boolean;製品グループがロックされているかどうかを示します。 デフォルト値はtrueです。
    • ProductGroupReferenceNumber; string; 外部システムとの統合に使用される一意の識別子。
    • StartDate; string; 製品グループがアクティブになる日時。
    • UsageRootFlag; string; アプリケーション使用タイプのコンテキストで、製品グループをルート製品グループとして割り当てて表示できるかどうかを示します。 デフォルト値はfalseです。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : setupSalesCatalogs
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : setupSalesCatalogs-item-response
タイプ: object
ソースを表示
  • タイトル: Active
    最大長: 1
    デフォルト値: Y
    製品グループがアクティブかどうかを示します。 デフォルト値はtrueです。
  • タイトル: Allow Duplicate Children
    最大長: 1
    デフォルト値: Y
    この製品グループ階層で重複する製品または製品グループを許可できるかどうかを示します。 デフォルト値はtrueです。
  • タイトル: Allow Selection
    最大長: 1
    製品グループを選択できるかどうかを示します。 有効な場合、値はY、それ以外の場合はNです。 防衛はY。
  • 最大長: 255
    デフォルト値: QSC_PROD_GROUPS_B
    添付エンティティ・タイプの名前。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    製品グループ・レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時。
  • 読取り専用: true
    販売カタログを削除できるかどうかを示します。 デフォルト値はtrueです。
  • タイトル: Effective to Date
    製品グループが非アクティブになる日時。
  • タイトル: Name
    最大長: 150
    製品グループの内部名。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    製品グループ・レコードを最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのセッション・ログイン。
  • Links
  • タイトル: Model Attributes
    最大長: 4000
    製品のモデル構成。
  • タイトル: Model Family
    最大長: 1000
    製品グループに関連付けられているモデル・ファミリの名前。
  • タイトル: Model Line
    最大長: 1000
    製品グループに関連付けられているモデル明細の名前。
  • タイトル: Model
    最大長: 1000
    製品グループのモデル名。
  • ロックの実装に使用される番号。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
  • タイトル: Description
    最大長: 1000
    ランタイム表示に使用される翻訳済製品グループ摘要。
  • 製品グループの一意の識別子。
  • タイトル: Display
    最大長: 250
    ランタイム表示に使用される製品グループの翻訳済名。
  • 製品グループ詳細の一意の識別子。
  • Attachments
    タイトル: Attachments
    添付リソースは、製品グループに関連付けられた添付の表示、作成、更新および削除に使用されます。 添付は通常、販売カタログの参照で製品グループを視覚的に識別できるように、イメージを製品グループに関連付けるために使用されます。
  • Filter Attributes
    タイトル: Filter Attributes
    フィルタ属性リソースは、製品グループに関連付けられたフィルタ属性の表示、作成、更新および削除に使用されます。 フィルタ属性を使用すると、顧客は色、テクスチャなどのマテリアル・プロパティなどのプリファレンスに基づいて製品をソートできます。
  • 読取り専用: true
    製品グループをロックしたユーザーの名前またはID。
  • 読取り専用: true
    製品グループがロックされた日付。
  • 読取り専用: true
    製品グループがロックされているかどうかを示します。 デフォルト値はtrueです。
  • Products
    タイトル: Products
    製品リソースは、製品グループに対する製品関連の表示、作成、更新および削除に使用されます。 通常、製品は製品グループ階層の最もリーフ・ノードに関連付けられます。 これらの製品は、Product Information Managementで定義されている品目から取得されます。
  • タイトル: Reference Number
    最大長: 50
    外部システムとの統合に使用される一意の識別子。
  • Related Groups
    タイトル: Related Groups
    関連グループ・リソースは、サブ製品グループと親製品グループ間の関連を表示、作成、更新および削除するために使用されます。 サブグループ・リソースを使用して製品グループをサブグループ関連に作成または更新できますが、そのような関連の削除は、関連グループ・リソースを使用してのみ実行できます。
  • Subgroups
    タイトル: Subgroups
    サブグループ・リソースは、製品グループの階層を作成できるように、サブ製品グループの親製品グループへの関連を表示、作成および更新するために使用します。
  • タイトル: Revenue Category
    最大長: 30
    製品グループに関連付けられた収益カテゴリを示すコード。 たとえば、ソフトウェア、メンテナンス、サービス、トレーニング、ハードウェアまたはバック・メンテナンスです。
  • タイトル: Revenue Role
    最大長: 30
    製品グループに関連付けられている収益ロールを示すコード。 たとえば、販売売上明細セットや販売売上明細セット・メンバーです。
  • タイトル: Effective from Date
    製品グループがアクティブになる日時。
  • 読取り専用: true
    販売カタログを更新できるかどうかを示します。 デフォルト値はtrueです。
  • タイトル: Root Catalog
    最大長: 1
    デフォルト値: N
    アプリケーション使用タイプのコンテキストで、製品グループをルート製品グループとして割り当てて表示できるかどうかを示します。 デフォルト値はfalseです。
ネストされたスキーマ : 添付ファイル
タイプ: array
タイトル: Attachments
添付リソースは、製品グループに関連付けられた添付の表示、作成、更新および削除に使用されます。 添付は通常、販売カタログの参照で製品グループを視覚的に識別できるように、イメージを製品グループに関連付けるために使用されます。
ソースを表示
ネストされたスキーマ : フィルタ属性
タイプ: array
タイトル: Filter Attributes
フィルタ属性リソースは、製品グループに関連付けられたフィルタ属性の表示、作成、更新および削除に使用されます。 フィルタ属性を使用すると、顧客は色、テクスチャなどのマテリアル・プロパティなどのプリファレンスに基づいて製品をソートできます。
ソースを表示
ネストされたスキーマ : 製品
タイプ: array
タイトル: Products
製品リソースは、製品グループに対する製品関連の表示、作成、更新および削除に使用されます。 通常、製品は製品グループ階層の最もリーフ・ノードに関連付けられます。 これらの製品は、Product Information Managementで定義されている品目から取得されます。
ソースを表示
ネストされたスキーマ : 関連グループ
タイプ: array
タイトル: Related Groups
関連グループ・リソースは、サブ製品グループと親製品グループ間の関連を表示、作成、更新および削除するために使用されます。 サブグループ・リソースを使用して製品グループをサブグループ関連に作成または更新できますが、そのような関連の削除は、関連グループ・リソースを使用してのみ実行できます。
ソースを表示
ネストされたスキーマ : サブグループ
タイプ: array
タイトル: Subgroups
サブグループ・リソースは、製品グループの階層を作成できるように、サブ製品グループの親製品グループへの関連を表示、作成および更新するために使用します。
ソースを表示
ネストされたスキーマ : setupSalesCatalogs-ProductGroupAttachments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : setupSalesCatalogs-ProductGroupAttributeSetup-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : フィルタ属性値
タイプ: array
タイトル: Filter Attribute Values
フィルタ属性値リソースは、製品グループに関連付けられたフィルタ属性の値を表示、作成、更新および削除するために使用されます。 たとえば、カラー・フィルタ属性には青や赤などの値があります。
ソースを表示
ネストされたスキーマ : setupSalesCatalogs-ProductGroupAttributeSetup-ProductGroupAttributeValueSetup-item-response
タイプ: object
ソースを表示
  • タイトル: Display
    最大長: 150
    属性値の名前。
  • タイトル: Internal Value
    最大長: 150
    属性値に対応するテキスト。
  • タイトル: Currency
    最大長: 15
    製品の登録価格および金額の通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Display Sequence
    属性ドメインの表示順序を手動で設定します。
  • Links
  • タイトル: Maximum Value
    範囲内の最大数値。
  • タイトル: Minimum Value
    範囲内の最小数値。
  • 製品グループの一意の識別子。
  • 製品グループ属性値の一意の識別子。
  • タイトル: Value
    値の一意の識別子。
ネストされたスキーマ : setupSalesCatalogs-ProductGroupProductSetup-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : EligibilityRules
タイプ: array
タイトル: EligibilityRules
適格ルール・リソースは、様々な適格ルールを表示、作成、更新および削除するために使用され、実行時に選択可能な製品が少数のみになります。 アイテムごとに、ルールが特定の国に対して有効か、全ての国に対して有効かを指定する資格ルールを1つ以上追加できます。
ソースを表示
ネストされたスキーマ : setupSalesCatalogs-ProductGroupProductSetup-EligibilityRules-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : setupSalesCatalogs-ProductGroupRelationSetup-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : setupSalesCatalogs-ProductGroupSubgroupAdministration-item-response
タイプ: object
ソースを表示
リンク
lockProductGroup
この処理によって、製品グループが編集のためにロックされ、製品グループ識別子がリクエスト本文に送信されます。
publishProductGroups
このアクションでは、すべての製品グループが公開されます。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してGET srequestを発行することによって、すべての製品グループを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs

レスポンス本文の例

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

{
"items": [
  {
"ProdGrpDetailsId": 100000011836340,
"UsageRootFlag": "Y",
"ProductGroupReferenceNumber": "100000011628006",
"ActiveFlag": "N",
"StartDate": "1951-01-01T00:00:00+00:00",
"EndDate": "4712-12-31T00:00:00+00:00",
"RevenueRoleCode": null,
"RevenueCategoryCode": null,
"AllowDuplicateContentFlag": "N",
"ProdGroupId": 100000011628005,
"ObjectVersionNumber": 71,
"InternalName": "WAVE_Electronics",
"UpdateFlag": false,
"DeleteFlag": false,
"ProductGroupLockedBy": "HWater",
"ProductGroupLockedFlag": true,
"ProductGroupLockedDate": "2016-06-30 23:02:42.756",
"ProdGroupName": "Electronics",
"ProdGroupDescription": "Electronics contains computers, printers and TVs ",
"AttachmentEntityName": "QSC_PROD_GROUPS_B",
"LastUpdateDate": "2016-06-30T23:03:10+00:00",
"LastUpdateLogin": "3687DFA066DC678EE053368FF00A96E2",
"LastUpdatedBy": "HWater",
"CreatedBy": "MARKETING_ADMINISTRATOR",
"CreationDate": "2009-07-24T16:47:09+00:00",
...
},
{
"ProdGrpDetailsId": 100000011628008,
"UsageRootFlag": "N",
"ProductGroupReferenceNumber": "100000011628008",
"ActiveFlag": "Y",
"StartDate": "1951-01-01T00:00:00+00:00",
"EndDate": "4712-12-31T00:00:00+00:00",
"RevenueRoleCode": null,
"RevenueCategoryCode": null,
"AllowDuplicateContentFlag": "N",
"ProdGroupId": 100000011628007,
"ObjectVersionNumber": 22,
"InternalName": "WAVE_Computer Systems",
"UpdateFlag": false,
"DeleteFlag": false,
"ProductGroupLockedBy": null,
"ProductGroupLockedFlag": false,
"ProductGroupLockedDate": null,
"ProdGroupName": "Computer Systems",
"ProdGroupDescription": "Hardware and Software components, includes database systems and other applications.",
"AttachmentEntityName": "QSC_PROD_GROUPS_B",
"LastUpdateDate": "2010-05-25T18:13:24+00:00",
"LastUpdateLogin": "8774F55BA5C96D47E04044987CF00D3A",
"LastUpdatedBy": "SALES_CATALOG_ADMINISTRATOR",
"CreatedBy": "-1",
"CreationDate": "2009-07-24T16:50:06+00:00",
...
}
「トップに戻る」