製品グループ使用の取得
get
/crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}
リクエスト
パス・パラメータ
- UsageCode(required): string
製品グループの使用コード。
問合せパラメータ
- 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 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : productGroupUsages-item-response
タイプ:
ソースを表示
object
-
AllowDupContentFlag: boolean
タイトル:
Allow Duplicate Content
最大長:1
デフォルト値:true
コンテンツの重複が許可されることを示します。 -
CreatedBy: string
読取り専用:
true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
レコードが作成された日付。 -
LastUpdateDate: string (date-time)
読取り専用:
true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
レコードを最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ProductGroupUsageEngine: array Product Group Usage Functions
タイトル:
Product Group Usage Functions
製品グループ使用エンジン・リソースは、製品グループの使用エンジンを表示するために使用されます。 -
ProductGroupUsageModeSetup: array Product Group Usage Modes
タイトル:
Product Group Usage Modes
製品グループ使用モード・リソースは、製品グループの使用モードを表示するために使用されます。 -
ProductGroupUsagePreferenceSetup: array Product Group Usage Preferences
タイトル:
Product Group Usage Preferences
製品グループ使用プリファレンス・リソースは、製品グループの使用プリファレンスを表示するために使用されます。 -
ProductGroupUsageRootProdGrpSetup: array Product Group Usage Roots
タイトル:
Product Group Usage Roots
製品グループ使用ルート・リソースは、製品グループの使用ルートを表示するために使用されます。 -
UsageCode: string
タイトル:
Usage Code
最大長:30
製品グループの使用コード。 -
UsageDescText: string
タイトル:
Description
最大長:250
製品グループ使用目的の使用目的摘要テキスト。 -
UsageName: string
タイトル:
Usage
最大長:100
製品グループ使用の名前。
ネストされたスキーマ : 製品グループ使用目的機能
タイプ:
array
タイトル:
Product Group Usage Functions
製品グループ使用エンジン・リソースは、製品グループの使用エンジンを表示するために使用されます。
ソースを表示
ネストされたスキーマ : 製品グループ使用モード
タイプ:
array
タイトル:
Product Group Usage Modes
製品グループ使用モード・リソースは、製品グループの使用モードを表示するために使用されます。
ソースを表示
ネストされたスキーマ : 製品グループ使用プリファレンス
タイプ:
array
タイトル:
Product Group Usage Preferences
製品グループ使用プリファレンス・リソースは、製品グループの使用プリファレンスを表示するために使用されます。
ソースを表示
ネストされたスキーマ : 製品グループ使用ルート
タイプ:
array
タイトル:
Product Group Usage Roots
製品グループ使用ルート・リソースは、製品グループの使用ルートを表示するために使用されます。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : productGroupUsages-ProductGroupUsageEngine-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
読取り専用:
true
最大長:64
使用エンジン・レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
使用エンジン・レコードが作成された日付。 -
LastUpdateDate: string (date-time)
読取り専用:
true
使用エンジン・レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
使用エンジン・レコードを最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
UsageCode: string
最大長:
30
使用エンジンの使用コード。 -
UsageModeCode: string
タイトル:
Mode
最大長:30
使用エンジンの使用モード・コード。 -
UsagePrefCode: string
タイトル:
Name
最大長:30
使用エンジンの使用プリファレンス・コード。 -
UsagePrefValue: string
タイトル:
Value
最大長:100
使用エンジンの使用プリファレンス値。
ネストされたスキーマ : productGroupUsages-ProductGroupUsageModeSetup-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
読取り専用:
true
最大長:64
使用モード設定を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
使用モード設定が作成された日付。 -
LastUpdateDate: string (date-time)
読取り専用:
true
使用モード設定が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
使用モード設定を最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ModeDescText: string
タイトル:
Description
最大長:250
設定の使用モードの説明。 -
UsageCode: string
最大長:
30
モード設定の使用コード。 -
UsageModeCode: string
タイトル:
Mode Code
最大長:30
モード設定の使用モード・コード。 -
UsageModeName: string
タイトル:
Mode
最大長:100
使用モードの名前。
ネストされたスキーマ : productGroupUsages-ProductGroupUsagePreferenceSetup-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
読取り専用:
true
最大長:64
使用プリファレンス設定レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
使用プリファレンス・セット・レコードが作成された日付。 -
LastUpdateDate: string (date-time)
読取り専用:
true
使用プリファレンス設定レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
使用プリファレンス設定レコードを最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
UsageCode: string
最大長:
30
プリファレンス設定の使用目的コード。 -
UsageModeCode: string
タイトル:
Mode
最大長:30
プリファレンス設定の使用モード・コード。 -
UsagePrefCode: string
タイトル:
Name
最大長:30
プリファレンス設定の使用プリファレンス・コード。 -
UsagePrefValue: string
タイトル:
Value
最大長:100
プリファレンス設定の使用プリファレンス値。
ネストされたスキーマ : productGroupUsages-ProductGroupUsageRootProdGrpSetup-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
読取り専用:
true
最大長:64
ルート製品グループ設定レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
ルート製品グループ設定レコードが作成された日付。 -
DisplayOrderNum: integer (int64)
タイトル:
Display Sequence
ルート製品グループ設定の表示順序番号。 -
EndDate: string (date-time)
タイトル:
Effective to Date
ルート製品グループの設定が終了する日付。 -
InternalName: string
タイトル:
Name
読取り専用:true
最大長:150
製品グループの内部名。 -
LastUpdateDate: string (date-time)
読取り専用:
true
ルート製品グループ設定レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
ルート製品グループ設定レコードを最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ProdGroupDescTxt: string
タイトル:
Description
読取り専用:true
最大長:1000
製品グループの摘要。 -
ProdGroupId: integer (int64)
読取り専用:
true
製品グループの一意の識別子。 -
ProdGroupName: string
タイトル:
Display
読取り専用:true
最大長:250
製品グループの名前。 -
ProdGrpRootsId: integer (int64)
製品グループ・ルートの一意の識別子。
-
StartDate: string (date-time)
タイトル:
Effective from Date
ルート製品グループの設定が開始される日付。 -
UsageCode: string
タイトル:
Usage Code
最大長:30
ルート製品グループ設定の使用コード。
リンク
- ProductGroupUsageEngine
-
パラメータ:
- UsageCode:
$request.path.UsageCode
製品グループ使用エンジン・リソースは、製品グループの使用エンジンを表示するために使用されます。 - UsageCode:
- ProductGroupUsageModeSetup
-
操作: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsageModeSetupパラメータ:
- UsageCode:
$request.path.UsageCode
製品グループ使用モード・リソースは、製品グループの使用モードを表示するために使用されます。 - UsageCode:
- ProductGroupUsagePreferenceSetup
-
パラメータ:
- UsageCode:
$request.path.UsageCode
製品グループ使用プリファレンス・リソースは、製品グループの使用プリファレンスを表示するために使用されます。 - UsageCode:
- ProductGroupUsageRootProdGrpSetup
-
パラメータ:
- UsageCode:
$request.path.UsageCode
製品グループ使用ルート・リソースは、製品グループの使用ルートを表示するために使用されます。 - UsageCode: