Create a subgroup relationship
post
/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup
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: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the related group relationship is active. The default value is true. -
DisplayOrderNum: integer
(int64)
Title:
Display Sequence
The manually set display order for related groups in a product group. -
EndDate: string
(date-time)
Title:
Effective to Date
The date after which the related group relationship is inactive. -
ParPGReferenceNumber: string
Title:
Parent Product Group Reference Number
Maximum Length:50
The par pgreferenceurations of the product. -
PGDetailsReferenceNumber: string
Title:
Reference Number
Maximum Length:50
The pgdetails referenceurations of the product. -
ProdGroupId: integer
(int64)
The unique identifier of the parent product group.
-
ProdGroupRelationshipId: integer
(int64)
The unique identifier of the product group relationship.
-
RelProdGroupId: integer
(int64)
Title:
Product Group
The unique identifier of the related child product group. -
StartDate: string
(date-time)
Title:
Effective from Date
The date from which the related group relationship is active.
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-ProductGroupRelationSetup-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the related group relationship is active. The default value is true. -
DisplayOrderNum: integer
(int64)
Title:
Display Sequence
The manually set display order for related groups in a product group. -
EndDate: string
(date-time)
Title:
Effective to Date
The date after which the related group relationship is inactive. -
InternalName: string
Title:
Name
Read Only:true
Maximum Length:150
The internal name of the product group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParPGReferenceNumber: string
Title:
Parent Product Group Reference Number
Maximum Length:50
The par pgreferenceurations of the product. -
PGDetailsReferenceNumber: string
Title:
Reference Number
Maximum Length:50
The pgdetails referenceurations of the product. -
ProdGroupId: integer
(int64)
The unique identifier of the parent product group.
-
ProdGroupRelationshipId: integer
(int64)
The unique identifier of the product group relationship.
-
RelProdGroupId: integer
(int64)
Title:
Product Group
The unique identifier of the related child product group. -
StartDate: string
(date-time)
Title:
Effective from Date
The date from which the related group relationship is active.
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.