Create a subgroup
post
/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupSubgroupAdministration
Request
Path Parameters
-
ProdGroupId(required): integer(int64)
The unique identifier of the product group.
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.
-
Upsert-Mode:
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
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. -
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. -
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.
Response
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-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.