createGroup
post
/ccadmin/v1/hreflangGroups
Create Hreflang Group.
Request
Supported Media Types
- application/json
Root Schema : createGroup_request
Type:
Show Source
object
-
groupMembers:
array groupMembers
The list of hreflang groups members
-
groupName:
string
Group name
Nested Schema : groupMemberObject
Type:
Show Source
object
-
localeId:
string
ID of the locale.
-
siteId:
string
ID of the site.
-
xDefault(optional):
boolean
Flag indicating if it is a default group member.
Example:
{
"xDefault":false,
"siteId":"siteB",
"localeId":"14"
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getGroup_response
Type:
Show Source
object
-
groupMembers(optional):
array groupMembers
The list of hreflang groups members
-
groupName(optional):
string
Group name
-
id(optional):
string
ID.
Nested Schema : items
Type:
Show Source
object
-
localeId(optional):
string
ID of the locale.
-
siteId(optional):
string
ID of the site.
-
xDefault(optional):
boolean
Flag indicating if it is a default group member.
Example Response (application/json)
{
"groupMembers":[
{
"xDefault":false,
"siteId":"siteB",
"localeId":"14"
},
{
"xDefault":true,
"siteId":"siteB",
"localeId":"16"
}
],
"groupName":"Test group",
"repositoryId":"200002",
"id":"200002"
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|183101|Unexpected error returned processing hreflang groups.|
|183104|Group with name ''{0}'' already exists.|
|183105|Error parsing input request.|
|183106|No default site-language combination has been selected.|
|183107|There can be only one default site-language combination.|
|183108|Site {0} does not exist.|
|183109|Locale {0} does not exist.|
|183110|Site ID cannot be empty.|
|183111|Locale ID cannot be empty.|
|183112|Group name cannot be empty.|
|183113|Locale ''{0}'' is not associated with site ''{1}''.|
|183114|Locale ''{0}'' and site ''{1}'' is already associated with an existing group.|
|183115|Multiple references of locale ''{0}''.|
|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code