Jump to

• Request
• Response

getLayout

get

/ccagent/v1/pages/layout/{path: .*}

Get Layout. Returns the layout(regions) of a specific page. If the layout ids are added to layoutsRendered parameter and included in the request and if it matches the current page's layout id, then only the region ids for the requested layout are returned, because regions are stored in the simple-cache.js on the client.

Request

Supported Media Types

• application/json

Path Parameters

• path: .*: string

Query Parameters

• layoutsRendered(optional): string
  Contains the list of layout ids rendered on the client. If any id in it matches the requested page's layout id, then only region ids are returned.
• pageParam(optional): string
  Page param (for example pageParam=cat90016).
• usePageId(optional): string
  Use specific repository id for page, rather than the default.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getLayout_response

Type: object

Show Source

• description(optional): string
  The page description.
• isPreview(optional): boolean
  Whether the server is in preview mode.
• keywords(optional): string
  The keywords for the page.
• layout(optional): string
  The layout id.
• regions(optional): array regions
  The region data for all the regions of a page.
• route(optional): string
  The page route.
• title(optional): string
  The page title.

{
    "properties":{
        "layout":{
            "description":"The layout id.",
            "type":"string"
        },
        "route":{
            "description":"The page route.",
            "type":"string"
        },
        "regions":{
            "description":"The region data for all the regions of a page.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "keywords":{
            "description":"The keywords for the page.",
            "type":"string"
        },
        "isPreview":{
            "description":"Whether the server is in preview mode.",
            "type":"boolean"
        },
        "description":{
            "description":"The page description.",
            "type":"string"
        },
        "title":{
            "description":"The page title.",
            "type":"string"
        }
    }
}

Nested Schema : regions

Type: array

The region data for all the regions of a page.

Show Source

• Array of: object items

{
    "description":"The region data for all the regions of a page.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : items

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Example Response (application/json)

{
    "layout":"agentCustomerSearchLayout",
    "regions":[
        {
            "width":12,
            "id":"12colAgentCustomerSearchRegion",
            "widgets":[
                {
                    "id":"agentNavigationInst_v1"
                },
                {
                    "id":"agentNotificationsInst"
                }
            ]
        },
        {
            "width":12,
            "id":"SecondaryNavigationRegionForCustomerSearch",
            "widgets":[
                {
                    "id":"secondaryNavigationCustomerSearchAndSelfRegistrationWidgetInst"
                }
            ]
        },
        {
            "width":12,
            "id":"agentCustomerRegistrationRegion",
            "widgets":[
                {
                    "id":"agentCustomerRegistrationInst_v1"
                }
            ]
        },
        {
            "width":12,
            "id":"popupStackCustomerSearch",
            "widgets":[
            ]
        },
        {
            "id":"globalWidgetsRegion0"
        },
        {
            "id":"globalWidgetsRegion1"
        }
    ],
    "route":"/agentCustomerSearch",
    "noindex":false,
    "isPreview":true,
    "metaTags":[
    ],
    "links":[
        {
            "rel":"self",
            "href":"/ccagentui/v1/pages/layout/agentCustomerSearch?layoutsRendered=agentCustomerSearchLayout"
        }
    ],
    "title":"Commerce Cloud Site",
    "layoutName":"Customer Search Layout - Agent"
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top