REST API for Oracle Commerce Cloud December 2017

listURLPatterns

get

/ccadmin/v1/urlPatterns

List URLPatterns. Returns a list of URL Patterns used to build Store Front URLs.

Request

Supported Media Types

application/json

Query Parameters

type: Type: string

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listURLPatterns_response

Properties

items: Type: array items

Additional Properties Allowed:

The list of URL pattern objects.

Nested Schema : items

Type: array

The list of URL pattern objects.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

autoRedirect: Type: boolean

Flag on whether to use the auto redirect functionality.
availableProperties: Type: array availableProperties

Additional Properties Allowed:

Properties available to use in URL Patterns
default: Type: string

Default URL Pattern.
example: Type: string

The example URL built off the default product/category of currently set URL Pattern.
name: Type: string

Name used in the admin ui.
repositoryId: Type: string

The repo id
translations: Type: object translations

Additional Properties Allowed:

List of translated URL Patterns
value: Type: string

The value of currently set URL Pattern.

Nested Schema : availableProperties

Type: array

Properties available to use in URL Patterns

Items

Type: string

Nested Schema : translations

Type: object

List of translated URL Patterns

Example application/json


[
    [
        {
            "availableProperties":[
                "description",
                "displayName",
                "id",
                "parentCategory",
                "seoDescriptionDerived",
                "seoTitleDerived",
                "seoUrlSlugDerived"
            ],
            "default":"/{seoTitleDerived}/category/{id}",
            "translations":{
                "1":"/{seoTitleDerived}/category/{id}"
            },
            "name":"Collection Page",
            "repositoryId":"categoryPageRoute",
            "autoRedirect":true,
            "value":"/{seoTitleDerived}/category/{id}",
            "example":"/cameras-and-camcorders/category/cameracat"
        },
        {
            "availableProperties":[
                "CountryOfOrigin",
                "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":"/samsung-f90bn-hd-flash-memory-camcorder/product/camcorder_1"
        }
    ]
]

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

[[
  {
    "availableProperties": [
      "description",
      "displayName",
      "id",
      "parentCategory",
      "seoDescriptionDerived",
      "seoTitleDerived",
      "seoUrlSlugDerived"
    ],
    "default": "/{seoTitleDerived}/category/{id}",
    "translations": {"1": "/{seoTitleDerived}/category/{id}"},
    "name": "Collection Page",
    "repositoryId": "categoryPageRoute",
    "autoRedirect": true,
    "value": "/{seoTitleDerived}/category/{id}",
    "example": "/cameras-and-camcorders/category/cameracat"
  },
  {
    "availableProperties": [
      "CountryOfOrigin",
      "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": "/samsung-f90bn-hd-flash-memory-camcorder/product/camcorder_1"
  }
]]