Get all subgroups within a product group
get
/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupSubgroupAdministration
Request
Path Parameters
-
ProdGroupId(required): integer(int64)
The unique identifier of the product group.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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:- PrimaryKey: Finds a product group administration by the relationship identifier and product group identifier.
Finder Variables:- ProdGroupId; integer; The unique product group identifier.
- ProdGroupRelationshipId; integer; The unique identifier used to locate relationship.
- ProdGrpDetailsId; integer.
- SubProductGroupIdRowFinder: Finds a product group administration by product group identifier.
Finder Variables:- ProdGroupId; integer; The unique product group identifier.
- PrimaryKey: Finds a product group administration by the relationship identifier and product group identifier.
-
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:- AllowSelectionFlag; string; Indicates whether the product group can be selected. If enabled, the value is Y, else the value is N. The defalt is Y.
- BatchKeyText; string; The transient information about the batch process that is updating denormalization data based on this value in a group. This column is for internal use.
- CreatedBy; string; The user who created the product group record.
- CreationDate; string; The date and time when the record was created.
- EndDate; string; The date and time when the product group becomes inactive.
- GroupAssociationActiveStatus; string; The status of the relationship between parent and child product group.
- GroupAssociationDisplaySequence; integer; The display order in which the sub-product group appears in the user interface.
- GroupAssociationEffectiveFromDate; string; The date from which the relationship between parent and child product group is effective.
- GroupAssociationEffectiveToDate; string; The date till which the relationship between parent and child product group is effective.
- InternalName; string; The internal name of the product group.
- ModelConfigAttributes; string; The model configurations of the product.
- 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.
- ParentProductGroupId; integer; The unique identifier of the parent of the product group.
- ProdGroupDescription; string; The description of the sub-product group.
- ProdGroupId; integer; The unique identifier of the product group.
- ProdGroupName; string; The name of the sub-product group.
- ProdGroupRelationName; string; The name of the relationship between parent and child product group.
- ProdGroupRelationshipId; integer; The unique identifier of the product group relationship.
- ProdGrpDetailsId; integer; The unique identifier of the product group details.
- ProductGroupReferenceNumber; string; The unique identifier used for integration with external systems.
- RuntimeRevisionNumber; integer; The version number used during runtime.
- StartDate; string; The date and time when the product group becomes active.
- UsageRootFlag; string; Indicates whether the product group can be assigned and displayed as a root product group in the context of an application usage type. The default value is false.
- UserLastUpdateDate; string; The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database.
-
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(required):
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(required):
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 : setupSalesCatalogs-ProductGroupSubgroupAdministration
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 : setupSalesCatalogs-ProductGroupSubgroupAdministration-item-response
Type:
Show Source
object
-
ActiveFlag: string
Title:
Active
Maximum Length:1
Default Value:Y
Indicates whether the product group is active or not. -
AllowDuplicateContentFlag: string
Title:
Allow Duplicate Children
Maximum Length:1
Default Value:Y
Indicates whether a duplicate product or product group can be allowed in this product group hierarchy. The default value is false. -
AllowSelectionFlag: string
Title:
Allow Selection
Maximum Length:1
Indicates whether the product group can be selected. If enabled, the value is Y, else the value is N. The defalt is Y. -
BatchKeyText: string
Maximum Length:
50
The transient information about the batch process that is updating denormalization data based on this value in a group. This column is for internal use. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the product group record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
EndDate: string
(date-time)
Title:
Effective to Date
The date and time when the product group becomes inactive. -
GroupAssociationActiveStatus: string
Title:
Active
Maximum Length:1
Default Value:Y
The status of the relationship between parent and child product group. -
GroupAssociationDisplaySequence: integer
(int64)
Title:
Display Sequence
The display order in which the sub-product group appears in the user interface. -
GroupAssociationEffectiveFromDate: string
(date-time)
Title:
Effective from Date
The date from which the relationship between parent and child product group is effective. -
GroupAssociationEffectiveToDate: string
(date-time)
Title:
Effective to Date
The date till which the relationship between parent and child product group is effective. -
InternalName: string
Title:
Name
Maximum Length:150
The internal name of the product group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModelConfigAttributes: string
Title:
Model Attributes
Maximum Length:4000
The model configurations of the product. -
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. -
ParentProductGroupId: integer
(int64)
The unique identifier of the parent of the product group.
-
ProdGroupDescription: string
Title:
Description
Maximum Length:1000
The description of the sub-product group. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGroupName: string
Title:
Display
Maximum Length:250
The name of the sub-product group. -
ProdGroupRelationDescription: string
The description of the relationship between parent and child product group.
-
ProdGroupRelationName: string
Title:
Display
Maximum Length:250
The name of the relationship between parent and child product group. -
ProdGroupRelationshipId: integer
(int64)
The unique identifier of the product group relationship.
-
ProdGrpDetailsId: integer
(int64)
The unique identifier of the product group details.
-
ProductGroupReferenceNumber: string
Title:
Reference Number
Maximum Length:50
The unique identifier used for integration with external systems. -
RevenueCategoryCode: string
Title:
Revenue Category
Maximum Length:30
The code indicating the revenue category associated with the product group. For example, Software, Maintenance, Service, Training, Hardware, or Back Maintenance. -
RevenueRoleCode: string
Title:
Revenue Role
Maximum Length:30
The code indicating the revenue role associated with the product group. For example, Sales revenue line set or Sales revenue line set member. -
RuntimeRevisionNumber: integer
(int64)
Default Value:
1
The version number used during runtime. -
StartDate: string
(date-time)
Title:
Effective from Date
The date and time when the product group becomes active. -
UsageRootFlag: string
Title:
Root Catalog
Maximum Length:1
Default Value:N
Indicates whether the product group can be assigned and displayed as a root product group in the context of an application usage type. The default value is false. -
UserLastUpdateDate: string
(date-time)
The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database.
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.