updateURLPattern
put
/ccadmin/v1/urlPatterns/{id}
Update a URL pattern. Update a URL method based on ID and request parameters.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
ID of the URL pattern
Root Schema : updateURLPattern_request
Type:
Show Source
object
-
autoRedirect(optional):
boolean
Default Value:
true
Flag on whether to use the auto redirect functionality. -
value(optional):
string
Default Value:
/{seoTitleDerived}/category/{id}
The value of currently set URL Pattern.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateURLPattern_response
Type:
Show Source
object
-
items(optional):
array items
The list of URL pattern objects.
Nested Schema : items
Type:
Show Source
object
-
autoRedirect(optional):
boolean
Flag on whether to use the auto redirect functionality.
-
availableProperties(optional):
array availableProperties
Properties available to use in URL Patterns
-
default(optional):
string
Default URL Pattern.
-
example(optional):
string
The example URL built off the default product/category of currently set URL Pattern.
-
name(optional):
string
Name used in the admin ui.
-
repositoryId(optional):
string
The repo id
-
translations(optional):
object translations
List of translated URL Patterns
-
value(optional):
string
The value of currently set URL Pattern.
Nested Schema : availableProperties
Type:
array
Properties available to use in URL Patterns
Show Source
Nested Schema : translations
Type:
object
List of translated URL Patterns
Example Response (application/json)
[
{
"availableProperties":[
"description",
"displayName",
"id",
"parentCategory",
"seoDescriptionDerived",
"seoTitleDerived",
"seoUrlSlugDerived"
],
"default":"/{seoTitleDerived}/category/{id}",
"translations":{
"1":"/{seoTitleDerived}/category/{id}"
},
"name":"Category Page",
"repositoryId":"categoryPageRoute",
"autoRedirect":true,
"value":"/{seoTitleDerived}/category/{id}",
"example":"/skirts/category/cat70008"
},
{
"availableProperties":[
"brand",
"description",
"displayName",
"id",
"parentCategory",
"seoDescriptionDerived",
"seoTitleDerived",
"seoUrlSlugDerived",
"type"
],
"default":"/{seoTitleDerived}/product/{id}",
"translations":{
"1":"/{seoTitleDerived}/product/{id}"
},
"name":"Product Page",
"repositoryId":"productPageRoute",
"autoRedirect":true,
"value":"/{seoTitleDerived}/product/{id}",
"example":"/a-line-skirt/product/xprod2535"
}
]
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