Create a product group - Not Supported
post
/crmRestApi/resources/11.13.18.05/catalogProductGroups
Request
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.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AllowDuplicateContentFlag: string
Title:
Allow Duplicate ChildrenMaximum Length:1Default Value:YIndicates the content flag for the product group. -
AllowSelectionFlag: string
Title:
Allow SelectionMaximum Length:1Indicates whether the product group can be selected. -
Attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view the attachments of a product group. An attachment includes additional information about the product group. -
FilterByTM: string
Maximum Length:
1The filter by TM. -
ModelConfigAttributes: string
Title:
Model AttributesMaximum Length:4000The configuration attributes of the product group. -
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. -
OverrideAllowSelectionYN: string
Title:
Override Allow SelectionMaximum Length:1The override allow selection of the product group. -
ProdGrpDetailsId: integer
(int64)
The unique identifier of the product group details.
-
ProductGroupReferenceNumber: string
Title:
Reference NumberMaximum Length:50The reference number of the product group. -
ProductGroupTranslation: array
Translations
Title:
TranslationsThe product group resource is used to view the language code, the translated product group name and description, and the product group ID. -
RevenueCategoryCode: string
Title:
Revenue CategoryMaximum Length:30The revenue category code associated with the product group. -
RevenueRoleCode: string
Title:
Revenue RoleMaximum Length:30The revenue code associated with the product group. -
UsageCode: string
Maximum Length:
255The usage code associated with the product group. -
UsageModeCode: string
Maximum Length:
255The usage mode code associated with the product group. -
UsageRootFlag: string
Title:
Root CatalogMaximum Length:1Default Value:NIndicates whether the group is a root group.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe 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 : Translations
Type:
arrayTitle:
TranslationsThe 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 : schema
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEThe code associated with the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The unique identifier of the document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The path of attachment file. -
DmVersionNumber: string
Maximum Length:
255The version number of the document. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe code indicating the type of the error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe content of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The name of the attachment file. -
FileUrl: string
Title:
File UrlThe file URL of the attachment. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment file. -
UploadedFileLength: integer
Title:
File SizeThe length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name of the attachment file. -
UploadedText: string
Title:
Uploaded TextThe text of the attachment file. -
Uri: string
Title:
UriMaximum Length:4000The URI of the attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of the attachment.
Nested Schema : schema
Type:
Show Source
object-
Language: string
Maximum Length:
4The language in which the product group is translated. -
ProdGroupDescription: string
Title:
DescriptionMaximum Length:1000The translated description of the product group. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGroupName: string
Title:
Product GroupMaximum Length:250The translated name of the product group.
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 : catalogProductGroups-item-response
Type:
Show Source
object-
AllowDuplicateContentFlag: string
Title:
Allow Duplicate ChildrenMaximum Length:1Default Value:YIndicates the content flag for the product group. -
AllowSelectionFlag: string
Title:
Allow SelectionMaximum Length:1Indicates whether the product group can be selected. -
AttachmentEntityName: string
Read Only:
trueThe attachment entity name of the product group. -
Attachments: array
Attachments
Title:
AttachmentsThe 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:
trueThe difference between the level of the first and the last product group in the path. -
FilterByTM: string
Maximum Length:
1The filter by TM. -
FirstProdGrpId: integer
(int64)
Read Only:
trueThe unique identifier of the first product group on the list. -
InternalName: string
Title:
NameRead Only:trueMaximum Length:150The internal name of the product group. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date and time when the product group was last updated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ModelConfigAttributes: string
Title:
Model AttributesMaximum Length:4000The configuration attributes of the product group. -
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. -
OverrideAllowSelectionYN: string
Title:
Override Allow SelectionMaximum Length:1The override allow selection of the product group. -
ParentProductGroupId: integer
(int64)
Read Only:
trueThe unique identifier of the parent product group for the penultimate node in the path. -
PathId: integer
(int64)
Read Only:
trueThe unique identifier of the path. -
ProdGrpDetailsId: integer
(int64)
The unique identifier of the product group details.
-
ProductGroupDenormId: integer
(int64)
Read Only:
trueThe unique identifier of the product group denorm. -
ProductGroupDescription: string
Title:
DescriptionRead Only:trueMaximum Length:1000The translated product group description used for runtime display. -
ProductGroupId: integer
(int64)
Read Only:
trueThe unique identifier of the product group. -
ProductGroupName: string
Title:
DisplayRead Only:trueMaximum Length:250The translated name of the product group used for runtime display. -
ProductGroupReferenceNumber: string
Title:
Reference NumberMaximum Length:50The reference number of the product group. -
ProductGroupTranslation: array
Translations
Title:
TranslationsThe 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 NumberRead Only:trueMaximum Length:50The reference number for integration with external systems. -
RevenueCategoryCode: string
Title:
Revenue CategoryMaximum Length:30The revenue category code associated with the product group. -
RevenueRoleCode: string
Title:
Revenue RoleMaximum Length:30The revenue code associated with the product group. -
UsageCode: string
Maximum Length:
255The usage code associated with the product group. -
UsageModeCode: string
Maximum Length:
255The usage mode code associated with the product group. -
UsageRootFlag: string
Title:
Root CatalogMaximum Length:1Default Value:NIndicates whether the group is a root group.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Translations
Type:
arrayTitle:
TranslationsThe 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 IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name of the person who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the attachment record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEThe code associated with the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The unique identifier of the document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The path of attachment file. -
DmVersionNumber: string
Maximum Length:
255The version number of the document. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe code indicating the type of the error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe content of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The name of the attachment file. -
FileUrl: string
Title:
File UrlThe file URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name of the person who last updated the attachment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment file. -
UploadedFileLength: integer
Title:
File SizeThe length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name of the attachment file. -
UploadedText: string
Title:
Uploaded TextThe text of the attachment file. -
Uri: string
Title:
UriMaximum Length:4000The URI of the attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The user name of the person who created the attachment.
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.
Nested Schema : catalogProductGroups-ProductGroupTranslation-item-response
Type:
Show Source
object-
ISOLanguage: string
Read Only:
trueMaximum Length:2The ISO language associated with the product group like English or Danish. -
ISOTerritory: string
Title:
TerritoryRead Only:trueMaximum Length:2The code associated with the ISO territory. -
Language: string
Maximum Length:
4The language in which the product group is translated. -
LanguageCode: string
Title:
Language CodeRead Only:trueMaximum Length:4The language code associated with the product group like 639-1en (English) or 639-1da (Danish). -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProdGroupDescription: string
Title:
DescriptionMaximum Length:1000The translated description of the product group. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGroupName: string
Title:
Product GroupMaximum Length:250The translated name of the product group.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- Attachments
-
Operation: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/AttachmentsParameters:
- ProductGroupDenormId:
$request.path.ProductGroupDenormId
The attachments resource is used to view the attachments of a product group. An attachment includes additional information about the product group. - ProductGroupDenormId:
- ProductGroupTranslation
-
Parameters:
- ProductGroupDenormId:
$request.path.ProductGroupDenormId
The product group resource is used to view the language code, the translated product group name and description, and the product group ID. - ProductGroupDenormId: