Get all product groups
get
/crmRestApi/resources/11.13.18.05/catalogProductGroups
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- GetParentProductGroups: Finds the parent product groups with the specified row finder.
Finder Variables:- Bind_InventoryItemId; integer.
- Bind_ProductGroupId; integer.
- Bind_UsageCode; string; The product groups bind usage code.
- Bind_UsageModeCode; string.
- PrimaryKey: Find the product group by the specified primary key.
Finder Variables:- ProdGrpDetailsId; integer.
- ProductGroupDenormId; integer; The unique identifier of the catalog product group.
- GetParentProductGroups: Finds the parent product groups with the specified row finder.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- Depth; integer; The difference between the level of the first and the last product group in the path.
- FilterByTM; string; The filter by TM.
- FirstProdGrpId; integer; The unique identifier of the first product group on the list.
- InternalName; string; The internal name of the product group.
- LastUpdateDate; string; The date and time when the product group was last updated.
- ModelConfigAttributes; string; The configuration attributes of the product group.
- ModelFamily; string; The name of the model family associated with the Product Group.
- ModelLine; string; The name of the model line associated with the Product Group.
- ModelName; string; The model name of the product group.
- OverrideAllowSelectionYN; string; The override allow selection of the product group.
- ParentProductGroupId; integer; The unique identifier of the parent product group for the penultimate node in the path.
- PathId; integer; The unique identifier of the path.
- ProdGrpDetailsId; integer; The unique identifier of the product group details.
- ProductGroupDenormId; integer; The unique identifier of the product group denorm.
- ProductGroupDescription; string; The translated product group description used for runtime display.
- ProductGroupId; integer; The unique identifier of the product group.
- ProductGroupName; string; The translated name of the product group used for runtime display.
- ProductGroupReferenceNumber; string; The reference number of the product group.
- ReferenceNumber; string; The reference number for integration with external systems.
- RevenueCategoryCode; string; The revenue category code associated with the product group.
- RevenueRoleCode; string; The revenue code associated with the product group.
- UsageCode; string; The usage code associated with the product group.
- UsageModeCode; string; The usage mode code associated with the product group.
- UsageRootFlag; string; Indicates whether the group is a root group.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : catalogProductGroups
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : catalogProductGroups-item-response
Type:
Show Source
object
-
AllowDuplicateContentFlag: string
Title:
Allow Duplicate Children
Maximum Length:1
Default Value:Y
Indicates the content flag for the product group. -
AllowSelectionFlag: string
Title:
Allow Selection
Maximum Length:1
Indicates whether the product group can be selected. -
AttachmentEntityName: string
Read Only:
true
The attachment entity name of the product group. -
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view the attachments of a product group. An attachment includes additional information about the product group. -
Depth: integer
(int64)
Read Only:
true
The difference between the level of the first and the last product group in the path. -
FilterByTM: string
Maximum Length:
1
The filter by TM. -
FirstProdGrpId: integer
(int64)
Read Only:
true
The unique identifier of the first product group on the list. -
InternalName: string
Title:
Name
Read Only:true
Maximum Length:150
The internal name of the product group. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the product group was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModelConfigAttributes: string
Title:
Model Attributes
Maximum Length:4000
The configuration attributes of the product group. -
ModelFamily: string
Title:
Model Family
Maximum Length:1000
The name of the model family associated with the Product Group. -
ModelLine: string
Title:
Model Line
Maximum Length:1000
The name of the model line associated with the Product Group. -
ModelName: string
Title:
Model
Maximum Length:1000
The model name of the product group. -
OverrideAllowSelectionYN: string
Title:
Override Allow Selection
Maximum Length:1
The override allow selection of the product group. -
ParentProductGroupId: integer
(int64)
Read Only:
true
The unique identifier of the parent product group for the penultimate node in the path. -
PathId: integer
(int64)
Read Only:
true
The unique identifier of the path. -
ProdGrpDetailsId: integer
(int64)
The unique identifier of the product group details.
-
ProductGroupDenormId: integer
(int64)
Read Only:
true
The unique identifier of the product group denorm. -
ProductGroupDescription: string
Title:
Description
Read Only:true
Maximum Length:1000
The translated product group description used for runtime display. -
ProductGroupId: integer
(int64)
Read Only:
true
The unique identifier of the product group. -
ProductGroupName: string
Title:
Display
Read Only:true
Maximum Length:250
The translated name of the product group used for runtime display. -
ProductGroupReferenceNumber: string
Title:
Reference Number
Maximum Length:50
The reference number of the product group. -
ProductGroupTranslation: array
Translations
Title:
Translations
The product group resource is used to view the language code, the translated product group name and description, and the product group ID. -
ReferenceNumber: string
Title:
Reference Number
Read Only:true
Maximum Length:50
The reference number for integration with external systems. -
RevenueCategoryCode: string
Title:
Revenue Category
Maximum Length:30
The revenue category code associated with the product group. -
RevenueRoleCode: string
Title:
Revenue Role
Maximum Length:30
The revenue code associated with the product group. -
UsageCode: string
Maximum Length:
255
The usage code associated with the product group. -
UsageModeCode: string
Maximum Length:
255
The usage mode code associated with the product group. -
UsageRootFlag: string
Title:
Root Catalog
Maximum Length:1
Default Value:N
Indicates whether the group is a root group.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view the attachments of a product group. An attachment includes additional information about the product group.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Translations
Type:
array
Title:
Translations
The product group resource is used to view the language code, the translated product group name and description, and the product group ID.
Show Source
Nested Schema : catalogProductGroups-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code associated with the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The path of attachment file. -
DmVersionNumber: string
Maximum Length:
255
The version number of the document. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of the error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The name of the attachment file. -
FileUrl: string
Title:
File Url
The file URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name of the person who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment file. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment file. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The user name of the person who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : catalogProductGroups-ProductGroupTranslation-item-response
Type:
Show Source
object
-
ISOLanguage: string
Read Only:
true
Maximum Length:2
The ISO language associated with the product group like English or Danish. -
ISOTerritory: string
Title:
Territory
Read Only:true
Maximum Length:2
The code associated with the ISO territory. -
Language: string
Maximum Length:
4
The language in which the product group is translated. -
LanguageCode: string
Title:
Language Code
Read Only:true
Maximum Length:4
The language code associated with the product group like 639-1en (English) or 639-1da (Danish). -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProdGroupDescription: string
Title:
Description
Maximum Length:1000
The translated description of the product group. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGroupName: string
Title:
Product Group
Maximum Length:250
The translated name of the product group.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to get all catalog product groups by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X
https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/catalogProductGroups
Example of Response Body
The following shows an example of the response body in JSON format.
{ "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" } ] }