Jump to

• Request
• Response

getAllStackDescriptorsByPageType

get

/ccadmin/v1/stackDescriptors/pageType/{id}

Get All Stack Descriptors By Page Type. Retrieves all Stack Descriptors by Page Type

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The Page Type ID.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getAllStackDescriptorsByPageType_response

Type: object

Show Source

• autoWrap(optional): boolean
  description of autoWrap
• items(optional): array items
  description of items

{
    "properties":{
        "autoWrap":{
            "description":"description of autoWrap",
            "type":"boolean"
        },
        "items":{
            "description":"description of items",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "isLatestVersion":{
                        "description":"description of isLatestVersion",
                        "type":"boolean"
                    },
                    "previousButton":{
                        "description":"description of previousButton",
                        "type":"string"
                    },
                    "regions":{
                        "description":"description of regions",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "repositoryId":{
                                    "description":"description of repositoryId",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "displayName":{
                        "description":"description of displayName",
                        "type":"string"
                    },
                    "availableToAllPages":{
                        "description":"description of availableToAllPages",
                        "type":"boolean"
                    },
                    "minWidth":{
                        "description":"description of minWidth",
                        "type":"integer"
                    },
                    "version":{
                        "description":"description of version",
                        "type":"integer"
                    },
                    "nextButton":{
                        "description":"description of nextButton",
                        "type":"string"
                    },
                    "latestVersion":{
                        "description":"description of latestVersion",
                        "type":"integer"
                    },
                    "repositoryId":{
                        "description":"description of repositoryId",
                        "type":"string"
                    },
                    "id":{
                        "description":"description of id",
                        "type":"string"
                    },
                    "pageTypes":{
                        "description":"description of pageTypes",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "repositoryId":{
                                    "description":"description of repositoryId",
                                    "type":"string"
                                },
                                "alias":{
                                    "description":"description of alias",
                                    "type":"string"
                                },
                                "id":{
                                    "description":"description of id",
                                    "type":"string"
                                },
                                "shortName":{
                                    "description":"description of shortName",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "stackType":{
                        "description":"description of stackType",
                        "type":"string"
                    },
                    "configurable":{
                        "description":"description of configurable",
                        "type":"boolean"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

description of items

Show Source

• Array of: object items

{
    "description":"description of items",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "isLatestVersion":{
                "description":"description of isLatestVersion",
                "type":"boolean"
            },
            "previousButton":{
                "description":"description of previousButton",
                "type":"string"
            },
            "regions":{
                "description":"description of regions",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "repositoryId":{
                            "description":"description of repositoryId",
                            "type":"string"
                        }
                    }
                }
            },
            "displayName":{
                "description":"description of displayName",
                "type":"string"
            },
            "availableToAllPages":{
                "description":"description of availableToAllPages",
                "type":"boolean"
            },
            "minWidth":{
                "description":"description of minWidth",
                "type":"integer"
            },
            "version":{
                "description":"description of version",
                "type":"integer"
            },
            "nextButton":{
                "description":"description of nextButton",
                "type":"string"
            },
            "latestVersion":{
                "description":"description of latestVersion",
                "type":"integer"
            },
            "repositoryId":{
                "description":"description of repositoryId",
                "type":"string"
            },
            "id":{
                "description":"description of id",
                "type":"string"
            },
            "pageTypes":{
                "description":"description of pageTypes",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "repositoryId":{
                            "description":"description of repositoryId",
                            "type":"string"
                        },
                        "alias":{
                            "description":"description of alias",
                            "type":"string"
                        },
                        "id":{
                            "description":"description of id",
                            "type":"string"
                        },
                        "shortName":{
                            "description":"description of shortName",
                            "type":"string"
                        }
                    }
                }
            },
            "stackType":{
                "description":"description of stackType",
                "type":"string"
            },
            "configurable":{
                "description":"description of configurable",
                "type":"boolean"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• availableToAllPages(optional): boolean
  description of availableToAllPages
• configurable(optional): boolean
  description of configurable
• displayName(optional): string
  description of displayName
• id(optional): string
  description of id
• isLatestVersion(optional): boolean
  description of isLatestVersion
• latestVersion(optional): integer
  description of latestVersion
• minWidth(optional): integer
  description of minWidth
• nextButton(optional): string
  description of nextButton
• pageTypes(optional): array pageTypes
  description of pageTypes
• previousButton(optional): string
  description of previousButton
• regions(optional): array regions
  description of regions
• repositoryId(optional): string
  description of repositoryId
• stackType(optional): string
  description of stackType
• version(optional): integer
  description of version

{
    "type":"object",
    "properties":{
        "isLatestVersion":{
            "description":"description of isLatestVersion",
            "type":"boolean"
        },
        "previousButton":{
            "description":"description of previousButton",
            "type":"string"
        },
        "regions":{
            "description":"description of regions",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"description of repositoryId",
                        "type":"string"
                    }
                }
            }
        },
        "displayName":{
            "description":"description of displayName",
            "type":"string"
        },
        "availableToAllPages":{
            "description":"description of availableToAllPages",
            "type":"boolean"
        },
        "minWidth":{
            "description":"description of minWidth",
            "type":"integer"
        },
        "version":{
            "description":"description of version",
            "type":"integer"
        },
        "nextButton":{
            "description":"description of nextButton",
            "type":"string"
        },
        "latestVersion":{
            "description":"description of latestVersion",
            "type":"integer"
        },
        "repositoryId":{
            "description":"description of repositoryId",
            "type":"string"
        },
        "id":{
            "description":"description of id",
            "type":"string"
        },
        "pageTypes":{
            "description":"description of pageTypes",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"description of repositoryId",
                        "type":"string"
                    },
                    "alias":{
                        "description":"description of alias",
                        "type":"string"
                    },
                    "id":{
                        "description":"description of id",
                        "type":"string"
                    },
                    "shortName":{
                        "description":"description of shortName",
                        "type":"string"
                    }
                }
            }
        },
        "stackType":{
            "description":"description of stackType",
            "type":"string"
        },
        "configurable":{
            "description":"description of configurable",
            "type":"boolean"
        }
    }
}

Nested Schema : pageTypes

Type: array

description of pageTypes

Show Source

• Array of: object items

{
    "description":"description of pageTypes",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"description of repositoryId",
                "type":"string"
            },
            "alias":{
                "description":"description of alias",
                "type":"string"
            },
            "id":{
                "description":"description of id",
                "type":"string"
            },
            "shortName":{
                "description":"description of shortName",
                "type":"string"
            }
        }
    }
}

Nested Schema : regions

Type: array

description of regions

Show Source

• Array of: object items

{
    "description":"description of regions",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"description of repositoryId",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• alias(optional): string
  description of alias
• id(optional): string
  description of id
• repositoryId(optional): string
  description of repositoryId
• shortName(optional): string
  description of shortName

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"description of repositoryId",
            "type":"string"
        },
        "alias":{
            "description":"description of alias",
            "type":"string"
        },
        "id":{
            "description":"description of id",
            "type":"string"
        },
        "shortName":{
            "description":"description of shortName",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId(optional): string
  description of repositoryId

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"description of repositoryId",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/stackDescriptors/pageType/checkoutPageType"
        }
    ],
    "autoWrap":true,
    "items":[
        {
            "isLatestVersion":true,
            "previousButton":"Previous",
            "regions":[
                {
                    "repositoryId":"progressTrackerStageOne"
                },
                {
                    "repositoryId":"progressTrackerStageTwo"
                },
                {
                    "repositoryId":"progressTrackerStageThree"
                }
            ],
            "displayName":"Progress Tracker",
            "availableToAllPages":false,
            "minWidth":1,
            "version":1,
            "nextButton":"Next",
            "latestVersion":1,
            "repositoryId":"progressTracker",
            "id":"progressTracker",
            "pageTypes":[
                {
                    "repositoryId":"checkoutPageType",
                    "alias":"/checkout",
                    "id":"checkoutPageType",
                    "shortName":"checkout"
                }
            ],
            "stackType":"progressTracker",
            "configurable":true
        }
    ]
}

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