Update a subgroup
patch
/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupSubgroupAdministration/{ProdGroupId2}
Request
Path Parameters
-
ProdGroupId(required): integer(int64)
The unique identifier of the product group.
-
ProdGroupId2(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context: string
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: string
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
ActiveFlag: string
Title:
ActiveMaximum Length:1Default Value:YIndicates whether the product group is active or not. -
AllowDuplicateContentFlag: string
Title:
Allow Duplicate ChildrenMaximum Length:1Default Value:YIndicates whether a duplicate product or product group can be allowed in this product group hierarchy. The default value is false. -
AllowSelectionFlag: string
Title:
Allow SelectionMaximum Length:1Indicates 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:
50The 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 DateThe date and time when the product group becomes inactive. -
GroupAssociationActiveStatus: string
Title:
ActiveMaximum Length:1Default Value:YThe status of the relationship between parent and child product group. -
GroupAssociationDisplaySequence: integer
(int64)
Title:
Display SequenceThe display order in which the sub-product group appears in the user interface. -
GroupAssociationEffectiveFromDate: string
(date-time)
Title:
Effective from DateThe date from which the relationship between parent and child product group is effective. -
GroupAssociationEffectiveToDate: string
(date-time)
Title:
Effective to DateThe date till which the relationship between parent and child product group is effective. -
ModelConfigAttributes: string
Title:
Model AttributesMaximum Length:4000The model configurations of the product. -
ModelFamily: string
Title:
Model FamilyMaximum Length:1000The name of the model family associated with the Product Group. -
ModelLine: string
Title:
Model LineMaximum Length:1000The name of the model line associated with the Product Group. -
ModelName: string
Title:
ModelMaximum Length:1000The model name of the product group. -
ParentProductGroupId: integer
(int64)
The unique identifier of the parent of the product group.
-
ProdGroupDescription: string
Title:
DescriptionMaximum Length:1000The description of the sub-product group. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGroupName: string
Title:
DisplayMaximum Length:250The name of the sub-product group. -
ProdGroupRelationDescription: string
The description of the relationship between parent and child product group.
-
ProdGroupRelationName: string
Title:
DisplayMaximum Length:250The name of the relationship between parent and child product group. -
ProdGroupRelationshipId: integer
(int64)
The unique identifier of the product group relationship.
-
RevenueCategoryCode: string
Title:
Revenue CategoryMaximum Length:30The code indicating the revenue category associated with the product group. For example, Software, Maintenance, Service, Training, Hardware, or Back Maintenance. -
RevenueRoleCode: string
Title:
Revenue RoleMaximum Length:30The 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:
1The version number used during runtime. -
StartDate: string
(date-time)
Title:
Effective from DateThe date and time when the product group becomes active. -
UsageRootFlag: string
Title:
Root CatalogMaximum Length:1Default Value:NIndicates 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:
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 : setupSalesCatalogs-ProductGroupSubgroupAdministration-item-response
Type:
Show Source
object-
ActiveFlag: string
Title:
ActiveMaximum Length:1Default Value:YIndicates whether the product group is active or not. -
AllowDuplicateContentFlag: string
Title:
Allow Duplicate ChildrenMaximum Length:1Default Value:YIndicates whether a duplicate product or product group can be allowed in this product group hierarchy. The default value is false. -
AllowSelectionFlag: string
Title:
Allow SelectionMaximum Length:1Indicates 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:
50The 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 ByRead Only:trueMaximum Length:64The user who created the product group record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the record was created. -
EndDate: string
(date-time)
Title:
Effective to DateThe date and time when the product group becomes inactive. -
GroupAssociationActiveStatus: string
Title:
ActiveMaximum Length:1Default Value:YThe status of the relationship between parent and child product group. -
GroupAssociationDisplaySequence: integer
(int64)
Title:
Display SequenceThe display order in which the sub-product group appears in the user interface. -
GroupAssociationEffectiveFromDate: string
(date-time)
Title:
Effective from DateThe date from which the relationship between parent and child product group is effective. -
GroupAssociationEffectiveToDate: string
(date-time)
Title:
Effective to DateThe date till which the relationship between parent and child product group is effective. -
InternalName: string
Title:
NameMaximum Length:150The internal name of the product group. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ModelConfigAttributes: string
Title:
Model AttributesMaximum Length:4000The model configurations of the product. -
ModelFamily: string
Title:
Model FamilyMaximum Length:1000The name of the model family associated with the Product Group. -
ModelLine: string
Title:
Model LineMaximum Length:1000The name of the model line associated with the Product Group. -
ModelName: string
Title:
ModelMaximum Length:1000The model name of the product group. -
ParentProductGroupId: integer
(int64)
The unique identifier of the parent of the product group.
-
ProdGroupDescription: string
Title:
DescriptionMaximum Length:1000The description of the sub-product group. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGroupName: string
Title:
DisplayMaximum Length:250The name of the sub-product group. -
ProdGroupRelationDescription: string
The description of the relationship between parent and child product group.
-
ProdGroupRelationName: string
Title:
DisplayMaximum Length:250The 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 NumberMaximum Length:50The unique identifier used for integration with external systems. -
RevenueCategoryCode: string
Title:
Revenue CategoryMaximum Length:30The code indicating the revenue category associated with the product group. For example, Software, Maintenance, Service, Training, Hardware, or Back Maintenance. -
RevenueRoleCode: string
Title:
Revenue RoleMaximum Length:30The 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:
1The version number used during runtime. -
StartDate: string
(date-time)
Title:
Effective from DateThe date and time when the product group becomes active. -
UsageRootFlag: string
Title:
Root CatalogMaximum Length:1Default Value:NIndicates 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Examples
cURL Command
The following example shows how to update a sub group relationship by submitting a PATCH request on the REST resource using cURL.
curl --user
sales_cloud_user -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788639/child/ProductGroupSubgroupAdministration/300100074788639
Example of Request Body
The following shows an example of the request body in JSON format.
{
"GroupAssociationEffectiveFromDate": "2016-06-18T00:00:00-07:00",
"GroupAssociationEffectiveToDate" : "2017-06-09T00:00:00-07:00",
"ActiveFlag" : "Y"
}
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"ProdGrpDetailsId": 300100074788638,
"UsageRootFlag": "N",
"ObjectVersionNumber": 1,
"RefNumber": "300100074788638",
"ActiveFlag": "Y",
"StartDate": "1951-01-01T00:00:00+00:00",
"EndDate": "4712-12-31T00:00:00+00:00",
"RevenueRoleCode": null,
"RevenueCategoryCode": null,
"AllowDuplicateContentFlag": "Y",
"BatchKeyText": null,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2016-06-20T01:11:44+00:00",
"InternalName": "WAVE_Demo/SubPG1/REST",
"ProdGroupId": 300100074788639,
"RuntimeRevisionNumber": 1,
"UserLastUpdateDate": null,
"ParentProductGroupId": 300100074788637,
"ProdGroupRelationshipId": 300100074788640,
"ProdGroupName": "WAVE_Demo/SubPG1/REST",
"ProdGroupDescription": "WAVE_Demo/SubPG1/REST",
"GroupAssociationEffectiveFromDate": "2016-06-18T07:00:00+00:00",
"GroupAssociationEffectiveToDate": "2017-06-09T07:00:00+00:00",
"GroupAssociationActiveStatus": "Y",
"GroupAssociationDisplaySequence": null,
"ProdGroupRelationName": null,
"ProdGroupRelationDescription": null,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788637/child/ProductGroupSubgroupAdministration/300100074788639",
"name": "ProductGroupSubgroupAdministration",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000003770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E0002000000017371007E00020000000278"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788637/child/ProductGroupSubgroupAdministration/300100074788639",
"name": "ProductGroupSubgroupAdministration",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788637",
"name": "setupSalesCatalogs",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788637/child/ProductGroupSubgroupAdministration/300100074788639/lov/LookupPVOForRevenueCategoryCode",
"name": "LookupPVOForRevenueCategoryCode",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788637/child/ProductGroupSubgroupAdministration/300100074788639/lov/LookupPVOForRevenueRoleCode",
"name": "LookupPVOForRevenueRoleCode",
"kind": "collection"
}
]
}