カタログ製品グループの取得
get
/crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}
リクエスト
パス・パラメータ
- ProductGroupDenormId(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 - 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のデフォルト・バージョンを選択します。
ルート・スキーマ : catalogProductGroups-item-response
タイプ:
ソースを表示
object
-
AllowDuplicateContentFlag: string
タイトル:
Allow Duplicate Children
最大長:1
デフォルト値:Y
製品グループのコンテンツ・フラグを示します。 -
AllowSelectionFlag: string
タイトル:
Allow Selection
最大長:1
製品グループを選択できるかどうかを示します。 -
AttachmentEntityName: string
読取り専用:
true
製品グループの添付エンティティ名。 -
Attachments: array Attachments
タイトル:
Attachments
添付リソースは、製品グループの添付を表示するために使用されます。 添付には、製品グループに関する追加情報が含まれます。 -
Depth: integer (int64)
読取り専用:
true
パス内の最初の製品グループと最後の製品グループのレベルの差異。 -
FilterByTM: string
最大長:
1
TMによるフィルタ。 -
FirstProdGrpId: integer (int64)
読取り専用:
true
リストの最初の製品グループの一意の識別子。 -
InternalName: string
タイトル:
Name
読取り専用:true
最大長:150
製品グループの内部名。 -
LastUpdateDate: string (date-time)
読取り専用:
true
製品グループが最後に更新された日時。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ModelConfigAttributes: string
タイトル:
Model Attributes
最大長:4000
製品グループの構成属性。 -
ModelFamily: string
タイトル:
Model Family
最大長:1000
製品グループに関連付けられているモデル・ファミリの名前。 -
ModelLine: string
タイトル:
Model Line
最大長:1000
製品グループに関連付けられているモデル明細の名前。 -
ModelName: string
タイトル:
Model
最大長:1000
製品グループのモデル名。 -
OverrideAllowSelectionYN: string
タイトル:
Override Allow Selection
最大長:1
上書きでは、製品グループを選択できます。 -
ParentProductGroupId: integer (int64)
読取り専用:
true
パス内の最後から2番目のノードに対する親製品グループの一意の識別子。 -
PathId: integer (int64)
読取り専用:
true
パスの一意の識別子。 -
ProdGrpDetailsId: integer (int64)
製品グループ詳細の一意の識別子。
-
ProductGroupDenormId: integer (int64)
読取り専用:
true
製品グループ非正規化の一意の識別子。 -
ProductGroupDescription: string
タイトル:
Description
読取り専用:true
最大長:1000
ランタイム表示に使用される翻訳済製品グループ摘要。 -
ProductGroupId: integer (int64)
読取り専用:
true
製品グループの一意の識別子。 -
ProductGroupName: string
タイトル:
Display
読取り専用:true
最大長:250
ランタイム表示に使用される製品グループの翻訳済名。 -
ProductGroupReferenceNumber: string
タイトル:
Reference Number
最大長:50
製品グループの参照番号。 -
ProductGroupTranslation: array Translations
タイトル:
Translations
製品グループ・リソースは、言語コード、翻訳済製品グループ名および摘要、製品グループIDの表示に使用されます。 -
ReferenceNumber: string
タイトル:
Reference Number
読取り専用:true
最大長:50
外部システムとの統合の参照番号。 -
RevenueCategoryCode: string
タイトル:
Revenue Category
最大長:30
製品グループに関連付けられた収益カテゴリ・コード。 -
RevenueRoleCode: string
タイトル:
Revenue Role
最大長:30
製品グループに関連付けられている収益コード。 -
UsageCode: string
最大長:
255
製品グループに関連付けられた使用コード。 -
UsageModeCode: string
最大長:
255
製品グループに関連付けられた使用モード・コード。 -
UsageRootFlag: string
タイトル:
Root Catalog
最大長:1
デフォルト値:N
グループがルート・グループであるかどうかを示します。
ネストされたスキーマ : 添付ファイル
タイプ:
array
タイトル:
Attachments
添付リソースは、製品グループの添付を表示するために使用されます。 添付には、製品グループに関する追加情報が含まれます。
ソースを表示
ネストされたスキーマ : 翻訳
タイプ:
array
タイトル:
Translations
製品グループ・リソースは、言語コード、翻訳済製品グループ名および摘要、製品グループIDの表示に使用されます。
ソースを表示
ネストされたスキーマ : catalogProductGroups-Attachments-item-response
タイプ:
ソースを表示
object
-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Id
ファイルのアップロードを支援するために添付UIコンポーネントで排他的に使用するために指定された属性。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id
添付文書の一意の識別子。 -
CategoryName: string
タイトル:
Category
最大長:30
添付のカテゴリ。 - ContentRepositoryFileShared: boolean
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:255
添付を作成したユーザー。 -
CreatedByUserName: string
タイトル:
Created By User Name
読取り専用:true
添付を作成した個人のユーザー名。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
添付レコードが作成された日時。 -
DatatypeCode: string
タイトル:
Type
最大長:30
デフォルト値:FILE
データ型に関連付けられたコード。 -
Description: string
タイトル:
Description
最大長:255
添付の説明。 -
DmDocumentId: string
最大長:
255
文書の一意の識別子。 -
DmFolderPath: string
タイトル:
Dm Folder Path
最大長:1000
添付ファイルのパス。 -
DmVersionNumber: string
最大長:
255
ドキュメントのバージョン番号。 -
DownloadInfo: string
タイトル:
DownloadInfo
添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。 -
ErrorStatusCode: string
タイトル:
Error Status Code
添付のエラー・タイプ(ある場合)を示すコード。 -
ErrorStatusMessage: string
タイトル:
Error Status Message
添付のエラー・メッセージ(ある場合)。 -
ExpirationDate: string (date-time)
タイトル:
Expiration Date
添付ファイルのコンテンツの有効期限。 -
FileContents: 文字列(バイト)
タイトル:
File Contents
添付のコンテンツ。 -
FileName: string
タイトル:
File Name
最大長:2048
添付ファイルの名前。 -
FileUrl: string
タイトル:
File Url
添付のファイルURL。 -
FileWebImage: 文字列(バイト)
タイトル:
File Web Image
読取り専用:true
ソースが変換可能なイメージの場合、.png形式で表示されるファイルのbase64エンコード・イメージ。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
添付が最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:255
添付を最後に更新したユーザー。 -
LastUpdatedByUserName: string
タイトル:
Last Updated By User
読取り専用:true
添付を最後に更新した個人のユーザー名。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Title: string
タイトル:
Title
添付のタイトル。 -
UploadedFileContentType: string
タイトル:
Uploaded File Content Type
添付ファイルのコンテンツ・タイプ。 -
UploadedFileLength: integer
タイトル:
File Size
添付ファイルの長さ。 -
UploadedFileName: string
タイトル:
Uploaded File Name
添付ファイルの名前。 -
UploadedText: string
タイトル:
Uploaded Text
添付ファイルのテキスト。 -
Uri: string
タイトル:
Uri
最大長:4000
添付のURI。 -
Url: string
タイトル:
Url
最大長:4000
添付のURL。 -
UserName: string
タイトル:
User Name
読取り専用:true
最大長:255
添付を作成した個人のユーザー名。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : catalogProductGroups-ProductGroupTranslation-item-response
タイプ:
ソースを表示
object
-
ISOLanguage: string
読取り専用:
true
最大長:2
英語やデンマーク語など、製品グループに関連付けられたISO言語。 -
ISOTerritory: string
タイトル:
Territory
読取り専用:true
最大長:2
ISOテリトリに関連付けられたコード。 -
Language: string
最大長:
4
製品グループが翻訳される言語。 -
LanguageCode: string
タイトル:
Language Code
読取り専用:true
最大長:4
639-1en (英語)や639-1da (デンマーク語)などの製品グループに関連付けられた言語コード。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ProdGroupDescription: string
タイトル:
Description
最大長:1000
製品グループの翻訳済摘要。 -
ProdGroupId: integer (int64)
製品グループの一意の識別子。
-
ProdGroupName: string
タイトル:
Product Group
最大長:250
製品グループの翻訳済名。
リンク
- 添付
-
パラメータ:
- ProductGroupDenormId:
$request.path.ProductGroupDenormId
添付リソースは、製品グループの添付を表示するために使用されます。 添付には、製品グループに関する追加情報が含まれます。 - ProductGroupDenormId:
- ProductGroupTranslation
-
パラメータ:
- ProductGroupDenormId:
$request.path.ProductGroupDenormId
製品グループ・リソースは、言語コード、翻訳済製品グループ名および摘要、製品グループIDの表示に使用されます。 - ProductGroupDenormId:
例:
次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、カタログ製品グループを取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{ "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" } ] }