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.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getAllStackDescriptorsByPageType_response
Type:
Show Source
object
-
autoWrap(optional):
boolean
description of autoWrap
-
items(optional):
array items
description of items
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : items
Type:
Show Source
object
-
alias(optional):
string
description of alias
-
id(optional):
string
description of id
-
repositoryId(optional):
string
description of repositoryId
-
shortName(optional):
string
description of shortName
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
description of repositoryId
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
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