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

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

get

/crmRestApi/resources/11.13.18.05/catalogProductGroups

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • GetParentProductGroups : 指定された行ファインダを持つ親製品グループを検索します。
      ファインダ変数:
      • Bind_InventoryItemId; integer.
      • Bind_ProductGroupId; integer.
      • Bind_UsageCode; string;製品グループは使用法コードをバインドします。
      • Bind_UsageModeCode; string.
    • PrimaryKey : 指定した主キーで製品グループを検索します。
      ファインダ変数:
      • ProdGrpDetailsId; integer.
      • ProductGroupDenormId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • 奥行き;整数;パス内の最初と最後の製品グループのレベルの差。
    • FilterByTM; string; TMによるフィルタ。
    • FirstProdGrpId; integer; リストの最初の製品グループの一意の識別子。
    • InternalName; string;製品グループの内部名。
    • LastUpdateDate; string; 製品グループが最後に更新された日時。
    • ModelConfigAttributes; string;製品グループの構成属性。
    • ModelFamily; string;製品グループに関連付けられたモデル・ファミリの名前。
    • ModelLine; string;製品グループに関連付けられたモデル行の名前。
    • ModelName; string;製品グループのモデル名。
    • OverrideAllowSelectionYN; string;上書きでは、製品グループを選択できます。
    • ParentProductGroupId; integer;パス内の最後から2番目のノードに対する親製品グループの一意の識別子。
    • PathId; integer;パスの一意の識別子。
    • ProdGrpDetailsId; integer;製品グループ詳細の一意の識別子。
    • ProductGroupDenormId; integer;製品グループ非正規化の一意の識別子。
    • ProductGroupDescription; string;実行時の表示に使用される翻訳済製品グループの説明。
    • ProductGroupId; integer; 製品グループの一意の識別子。
    • ProductGroupName; string;実行時の表示に使用される製品グループの翻訳済名。
    • ProductGroupReferenceNumber; string;製品グループの参照番号。
    • ReferenceNumber; string;外部システムとの統合のための参照番号。
    • RevenueCategoryCode; string;製品グループに関連付けられた収益カテゴリ・コード。
    • RevenueRoleCode; string;製品グループに関連付けられた収益コード。
    • UsageCode; string; 製品グループに関連付けられた使用コード。
    • UsageModeCode; string;製品グループに関連付けられた使用モード・コード。
    • UsageRootFlag; string; グループがルート・グループであるかどうかを示します。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : catalogProductGroups
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : catalogProductGroups-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 添付ファイル
タイプ: array
タイトル: Attachments
添付リソースは、製品グループの添付を表示するために使用されます。 添付には、製品グループに関する追加情報が含まれます。
ソースを表示
ネストされたスキーマ : 翻訳
タイプ: array
タイトル: Translations
製品グループ・リソースは、言語コード、翻訳済製品グループ名および摘要、製品グループIDの表示に使用されます。
ソースを表示
ネストされたスキーマ : catalogProductGroups-Attachments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : catalogProductGroups-ProductGroupTranslation-item-response
タイプ: object
ソースを表示
  • 読取り専用: true
    最大長: 2
    英語やデンマーク語など、製品グループに関連付けられたISO言語。
  • タイトル: Territory
    読取り専用: true
    最大長: 2
    ISOテリトリに関連付けられたコード。
  • 最大長: 4
    製品グループが翻訳される言語。
  • タイトル: Language Code
    読取り専用: true
    最大長: 4
    639-1en (英語)や639-1da (デンマーク語)などの製品グループに関連付けられた言語コード。
  • Links
  • タイトル: Description
    最大長: 1000
    製品グループの翻訳済摘要。
  • 製品グループの一意の識別子。
  • タイトル: Product Group
    最大長: 250
    製品グループの翻訳済名。
トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

{
    "items": [
        {
            "ProdGrpDetailsId": 100000011836340,
            "UsageRootFlag": "Y",
            "ProductGroupReferenceNumber": "100000011628006",
            "RevenueRoleCode": null,
            "RevenueCategoryCode": null,
            "AllowDuplicateContentFlag": "N",
            "AllowSelectionFlag": "Y",
            "ModelName": null,
            "ModelConfigAttributes": null,
            "LastUpdateDate": "2014-08-05T23:46:08.607+00:00",
            "ModelFamily": null,
            "ModelLine": null,
            "PathId": 100000011836004,
            "Depth": 0,
            "FirstProdGrpId": 100000011628005,
            "ParentProductGroupId": null,
            "ProductGroupDenormId": 100000011836003,
            "ProductGroupId": 100000011628005,
            "InternalName": "WAVE_Electronics",
            "ReferenceNumber": "100000011628006",
            "ProductGroupName": "Electronics",
            "ProductGroupDescription": "Electronics contains computers, printers and TVs\n",
            "UsageCode": null,
            "UsageModeCode": null,
            "FilterByTM": null,
            "AttachmentEntityName": "QSC_PROD_GROUPS_B",
            "OverrideAllowSelectionYN": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/catalogProductGroups/00020000000EACED0005770800005AF3112EDBB40000000EACED0005770800005AF3112EDA63",
                    "name": "catalogProductGroups",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/catalogProductGroups/00020000000EACED0005770800005AF3112EDBB40000000EACED0005770800005AF3112EDA63",
                    "name": "catalogProductGroups",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/catalogProductGroups/00020000000EACED0005770800005AF3112EDBB40000000EACED0005770800005AF3112EDA63/lov/LookupPVOForRevenueCategoryCode",
                    "name": "LookupPVOForRevenueCategoryCode",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/catalogProductGroups/00020000000EACED0005770800005AF3112EDBB40000000EACED0005770800005AF3112EDA63/lov/LookupPVOForRevenueRoleCode",
                    "name": "LookupPVOForRevenueRoleCode",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/catalogProductGroups/00020000000EACED0005770800005AF3112EDBB40000000EACED0005770800005AF3112EDA63/child/Attachments",
                    "name": "Attachments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/catalogProductGroups/00020000000EACED0005770800005AF3112EDBB40000000EACED0005770800005AF3112EDA63/child/ProductGroupTranslation",
                    "name": "ProductGroupTranslation",
                    "kind": "collection"
                }
            ]
        },
        .....
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/catalogProductGroups",
            "name": "catalogProductGroups",
            "kind": "collection"
        }
    ]
}
「トップに戻る」