generateURLSlugMap
put
/ccadmin/v1/urlPatterns/{id}/generate
Generate URL slugs for the URL pattern identified by the ID parameter.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
ID of the URL pattern
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds. Highlights any duplicates.
Root Schema : generateURLSlugMap_response
Type:
Show Source
object
-
containsDuplicates(optional):
boolean
Default Value:
true
Whether or not there are duplicate URL patterns. -
duplicates(optional):
array duplicates
Duplicate URL slugs.
Nested Schema : items
Type:
Show Source
object
-
en(optional):
array en
Duplicates for specified locale.
Nested Schema : items
Type:
Show Source
object
-
nintendo-switch(optional):
array nintendo-switch
Duplicate URL slug for the locale.
-
nintendo-switch (duplicate)(optional):
array nintendo-switch (duplicate)
Duplicate URL slug for the locale.
Nested Schema : nintendo-switch (duplicate)
Type:
array
Duplicate URL slug for the locale.
Show Source
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
Default Value:
Nintendo Switch
Item Display name. -
id(optional):
Default Value:
prod130047
ID for this item. -
itemDescriptor(optional):
Default Value:
product
The item descriptor. -
seoUrlSlugDerived(optional):
Default Value:
nintendo-switch
Item's URL slug.
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
Default Value:
Nintendo Switch games
Item Display name. -
id(optional):
Default Value:
video-games-123
ID for this item. -
itemDescriptor(optional):
Default Value:
category
The item descriptor. -
seoUrlSlugDerived(optional):
Default Value:
nintendo-switch
Item's URL slug.
Example Response (application/json)
{
"duplicates":{
"en":{
"nintendo-switch":{
"itemDescriptor":"product",
"displayName":"Nintendo Switch",
"seoUrlSlugDerived":"nintendo-switch",
"id":"prod130047"
},
"nintendo-switch (duplicate)":{
"itemDescriptor":"category",
"displayName":"Nintendo Switch games",
"seoUrlSlugDerived":"nintendo-switch",
"id":"video-games-123"
}
},
"containsDuplicates":true
}
}
Default Response
The error response
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