製品グループ内のすべてのサブグループを取得
get
/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupSubgroupAdministration
リクエスト
パス・パラメータ
- ProdGroupId(required): integer(int64)
製品グループの一意の識別子。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey : 関係識別子および製品グループ識別子で製品グループ管理を検索します。
ファインダ変数:- ProdGroupId; integer;一意の製品グループ識別子。
- ProdGroupRelationshipId; integer; 関係の検索に使用される一意の識別子。
- ProdGrpDetailsId; integer.
- SubProductGroupIdRowFinder : 製品グループ識別子別に製品グループ管理を検索します。
ファインダ変数:- ProdGroupId; integer;一意の製品グループ識別子。
- PrimaryKey : 関係識別子および製品グループ識別子で製品グループ管理を検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- AllowSelectionFlag; string; 製品グループを選択できるかどうかを示します。 有効な場合、値はY、それ以外の場合はNです。 防衛はY。
- BatchKeyText; string; グループ内のこの値に基づいて非正規化データを更新するバッチ・プロセスに関する一時的な情報。 この列は内部で使用されます。
- CreatedBy; string; 製品グループ・レコードを作成したユーザー。
- CreationDate; string; レコードが作成された日時。
- EndDate; string; 製品グループが非アクティブになる日時。
- GroupAssociationActiveStatus; string;親製品グループと子製品グループ間の関係のステータス。
- GroupAssociationDisplaySequence; integer;サブ製品グループがユーザー・インタフェースに表示される表示順序。
- GroupAssociationEffectiveFromDate; string; 親製品グループと子製品グループ間の関係が有効になる日付。
- GroupAssociationEffectiveToDate; string;親製品グループと子製品グループ間の関係が有効になるまでの日付。
- InternalName; string;製品グループの内部名。
- ModelConfigAttributes; string;製品のモデル構成。
- ModelFamily; string;製品グループに関連付けられたモデル・ファミリの名前。
- ModelLine; string;製品グループに関連付けられたモデル行の名前。
- ModelName; string;製品グループのモデル名。
- ParentProductGroupId; integer; 製品グループの一意の親識別子。
- ProdGroupDescription; string;サブ製品グループの説明。
- ProdGroupId; integer;製品グループの一意の識別子。
- ProdGroupName; string;サブ製品グループの名前。
- ProdGroupRelationName; string;親製品グループと子製品グループ間の関係の名前。
- ProdGroupRelationshipId; integer;製品グループ関係の一意の識別子。
- ProdGrpDetailsId; integer;製品グループ詳細の一意の識別子。
- ProductGroupReferenceNumber; string; 外部システムとの統合に使用される一意の識別子。
- RuntimeRevisionNumber; integer;実行時に使用されるバージョン番号。
- StartDate; string; 製品グループがアクティブになる日時。
- UsageRootFlag; string; アプリケーション使用タイプのコンテキストで、製品グループをルート製品グループとして割り当てて表示できるかどうかを示します。 デフォルト値はfalseです。
- UserLastUpdateDate; string; 行が最後に更新された日時。 更新が最初に別のデータベースで発生した場合、この値はLAST_UPDATE_DATEとは異なります。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : setupSalesCatalogs-ProductGroupSubgroupAdministration
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲で返されたリソース・インスタンスの数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内のアイテム。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : setupSalesCatalogs-ProductGroupSubgroupAdministration-item-response
タイプ:
ソースを表示
object
-
ActiveFlag: string
タイトル:
Active
最大長:1
デフォルト値:Y
製品グループがアクティブかどうかを示します。 -
AllowDuplicateContentFlag: string
タイトル:
Allow Duplicate Children
最大長:1
デフォルト値:Y
この製品グループ階層で重複する製品または製品グループを許可できるかどうかを示します。 デフォルト値はfalseです。 -
AllowSelectionFlag: string
タイトル:
Allow Selection
最大長:1
製品グループを選択できるかどうかを示します。 有効な場合、値はY、それ以外の場合はNです。 防衛はY。 -
BatchKeyText: string
最大長:
50
グループ内のこの値に基づいて非標準化データを更新しているバッチ・プロセスに関する一時的な情報。 この列は内部で使用されます。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
製品グループ・レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
EndDate: string (date-time)
タイトル:
Effective to Date
製品グループが非アクティブになる日時。 -
GroupAssociationActiveStatus: string
タイトル:
Active
最大長:1
デフォルト値:Y
親製品グループと子製品グループ間の関係のステータス。 -
GroupAssociationDisplaySequence: integer (int64)
タイトル:
Display Sequence
サブ製品グループがユーザー・インタフェースに表示される表示順序。 -
GroupAssociationEffectiveFromDate: string (date-time)
タイトル:
Effective from Date
親製品グループと子製品グループ間の関係が有効になる開始日。 -
GroupAssociationEffectiveToDate: string (date-time)
タイトル:
Effective to Date
親製品グループと子製品グループ間の関係が有効になる日付。 -
InternalName: string
タイトル:
Name
最大長:150
製品グループの内部名。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ModelConfigAttributes: string
タイトル:
Model Attributes
最大長:4000
製品のモデル構成。 -
ModelFamily: string
タイトル:
Model Family
最大長:1000
製品グループに関連付けられているモデル・ファミリの名前。 -
ModelLine: string
タイトル:
Model Line
最大長:1000
製品グループに関連付けられているモデル明細の名前。 -
ModelName: string
タイトル:
Model
最大長:1000
製品グループのモデル名。 -
ParentProductGroupId: integer (int64)
製品グループの一意の親識別子。
-
ProdGroupDescription: string
タイトル:
Description
最大長:1000
サブ製品グループの摘要。 -
ProdGroupId: integer (int64)
製品グループの一意の識別子。
-
ProdGroupName: string
タイトル:
Display
最大長:250
サブ製品グループの名前。 -
ProdGroupRelationDescription: string
親製品グループと子製品グループ間の関係の説明。
-
ProdGroupRelationName: string
タイトル:
Display
最大長:250
親製品グループと子製品グループ間の関係の名前。 -
ProdGroupRelationshipId: integer (int64)
製品グループ関係の一意の識別子。
-
ProdGrpDetailsId: integer (int64)
製品グループ詳細の一意の識別子。
-
ProductGroupReferenceNumber: string
タイトル:
Reference Number
最大長:50
外部システムとの統合に使用される一意の識別子。 -
RevenueCategoryCode: string
タイトル:
Revenue Category
最大長:30
製品グループに関連付けられた収益カテゴリを示すコード。 たとえば、ソフトウェア、メンテナンス、サービス、トレーニング、ハードウェアまたはバック・メンテナンスです。 -
RevenueRoleCode: string
タイトル:
Revenue Role
最大長:30
製品グループに関連付けられている収益ロールを示すコード。 たとえば、販売売上明細セットや販売売上明細セット・メンバーです。 -
RuntimeRevisionNumber: integer (int64)
デフォルト値:
1
実行時に使用されるバージョン番号。 -
StartDate: string (date-time)
タイトル:
Effective from Date
製品グループがアクティブになる日時。 -
UsageRootFlag: string
タイトル:
Root Catalog
最大長:1
デフォルト値:N
アプリケーション使用タイプのコンテキストで、製品グループをルート製品グループとして割り当てて表示できるかどうかを示します。 デフォルト値はfalseです。 -
UserLastUpdateDate: string (date-time)
行が最後に更新された日時。 更新が最初に別のデータベースで発生した場合、この値はLAST_UPDATE_DATEとは異なります。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
href: string
タイトル:
hyperlink reference
関連リソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連リソースの種類。 -
name: string
タイトル:
name
関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
例:
cURLコマンド
次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、製品グループ内のすべてのサブグループ関係を取得する方法を示しています。
curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788638/child/ProductGroupSubgroupAdministration
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "items": [ { "ProdGrpDetailsId": 300100074788638, "UsageRootFlag": "N", "ObjectVersionNumber": 1, "RefNumber": "300100074788638", "ActiveFlag": "Y", "StartDate": "1951-01-01T00:00:00+00:00", "EndDate": "4712-12-31T00:00:00+00:00", "RevenueRoleCode": null, "RevenueCategoryCode": null, "AllowDuplicateContentFlag": "Y", "BatchKeyText": null, "CreatedBy": "SALES_ADMIN", "CreationDate": "2016-06-20T01:11:44+00:00", "InternalName": "WAVE_Demo/SubPG1/REST", "ProdGroupId": 300100074788639, "RuntimeRevisionNumber": 1, "UserLastUpdateDate": null, "ParentProductGroupId": 300100074788637, "ProdGroupRelationshipId": 300100074788640, "ProdGroupName": "WAVE_Demo/SubPG1/REST", "ProdGroupDescription": "WAVE_Demo/SubPG1/REST", "GroupAssociationEffectiveFromDate": "2016-06-18T07:00:00+00:00", "GroupAssociationEffectiveToDate": "2017-06-09T07:00:00+00:00", "GroupAssociationActiveStatus": "Y", "GroupAssociationDisplaySequence": null, "ProdGroupRelationName": null, "ProdGroupRelationDescription": null, ... }