Jump to

• Request
• Response

getPages

get

/ccstore/v1/pages

Get Pages. Get all pages defined in the application.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getPages_response

Type: object

Show Source

• items(optional): array items
  List of pages along with their details.

{
    "properties":{
        "items":{
            "description":"List of pages along with their details.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "defaultPage":{
                        "description":"Whether the page is the default page for the site.",
                        "type":"boolean"
                    },
                    "pageType":{
                        "description":"The page type short name.",
                        "type":"string"
                    },
                    "route":{
                        "description":"The route property of the page.",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"The display name property of the page.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The repository ID of the page.",
                        "type":"string"
                    },
                    "pageTypeItem":{
                        "description":"The page type repository item",
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"The repository ID of the page type item.",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

List of pages along with their details.

Show Source

• Array of: object items

{
    "description":"List of pages along with their details.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "defaultPage":{
                "description":"Whether the page is the default page for the site.",
                "type":"boolean"
            },
            "pageType":{
                "description":"The page type short name.",
                "type":"string"
            },
            "route":{
                "description":"The route property of the page.",
                "type":"string"
            },
            "displayName":{
                "description":"The display name property of the page.",
                "type":"string"
            },
            "repositoryId":{
                "description":"The repository ID of the page.",
                "type":"string"
            },
            "pageTypeItem":{
                "description":"The page type repository item",
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The repository ID of the page type item.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• defaultPage(optional): boolean
  Whether the page is the default page for the site.
• displayName(optional): string
  The display name property of the page.
• pageType(optional): string
  The page type short name.
• pageTypeItem(optional): object pageTypeItem
  The page type repository item
• repositoryId(optional): string
  The repository ID of the page.
• route(optional): string
  The route property of the page.

{
    "type":"object",
    "properties":{
        "defaultPage":{
            "description":"Whether the page is the default page for the site.",
            "type":"boolean"
        },
        "pageType":{
            "description":"The page type short name.",
            "type":"string"
        },
        "route":{
            "description":"The route property of the page.",
            "type":"string"
        },
        "displayName":{
            "description":"The display name property of the page.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The repository ID of the page.",
            "type":"string"
        },
        "pageTypeItem":{
            "description":"The page type repository item",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"The repository ID of the page type item.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : pageTypeItem

Type: object

The page type repository item

Show Source

• repositoryId(optional): string
  The repository ID of the page type item.

{
    "description":"The page type repository item",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The repository ID of the page type item.",
            "type":"string"
        }
    }
}

Example Response (application/json)

[
    {
        "defaultPage":true,
        "pageType":"confirmation",
        "route":"/confirmation",
        "displayName":"Confirmation",
        "name":"confirmation",
        "repositoryId":"checkoutConfirmationPage",
        "rules":[
        ],
        "pageTypeItem":{
            "repositoryId":"checkoutConfirmationPageType"
        }
    },
    {
        "defaultPage":false,
        "pageType":"article",
        "route":"/privacy",
        "displayName":"Privacy",
        "name":"privacy",
        "repositoryId":"privacyPage",
        "rules":[
        ],
        "pageTypeItem":{
            "repositoryId":"articlePageType"
        }
    }
]

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