listStacks
get
/ccadmin/v1/stacks
List Stacks. List all the stacks by ID
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listStacks_response
Type:
Show Source
object
-
items(optional):
array items
List of stack instances
Nested Schema : items
Type:
Show Source
object
-
descriptor(optional):
object descriptor
Stack descriptor
-
displayName(optional):
string
Display name for stack instance
-
id(optional):
string
ID of stack instance
-
nextButton(optional):
string
Label for 'next' button
-
previousButton(optional):
string
Label for 'previous' button
-
repositoryId(optional):
string
Repository ID of stack instance
-
usingCodeView(optional):
boolean
Whether using code view
Nested Schema : descriptor
Type:
object
Stack descriptor
Show Source
-
availableToAllPages(optional):
boolean
Whether stack descriptor is available to all pages
-
configurable(optional):
boolean
Whether the stack descriptor is configurable
-
displayName(optional):
string
Display name of the stack descriptor
-
id(optional):
string
ID of the stack descriptor
-
isLatestVersion(optional):
boolean
Whether this is the latest version of the stack descriptor
-
latestVersion(optional):
integer
The latest version of the stack descriptor
-
minWidth(optional):
integer
The minimum width of the stack region
-
nextButton(optional):
string
Label for the 'next' button
-
pageTypes(optional):
array pageTypes
List of page types that the stack descriptor can be applied to
-
previousButton(optional):
string
Label for the 'previous' button
-
regions(optional):
array regions
List of stack step regions
-
repositoryId(optional):
string
Repository ID of the stack descriptor
-
stackType(optional):
string
Type of stack
-
version(optional):
integer
Stack version
Nested Schema : pageTypes
Type:
array
List of page types that the stack descriptor can be applied to
Show Source
Nested Schema : items
Type:
Show Source
object
-
alias(optional):
string
Page type alias
-
id(optional):
string
Page type ID
-
repositoryId(optional):
string
Page type repository ID
-
shortName(optional):
string
Page type name
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
Repository ID of stack step region
Example Response (application/json)
[
{
"nextButton":"Next",
"previousButton":"Previous",
"usingCodeView":false,
"displayName":"Progress Tracker",
"repositoryId":"re100002",
"descriptor":{
"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
},
"id":"re100002"
}
]
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