getStack
get
/ccadmin/v1/stacks/{id}
Get Stack. Get a stack based on ID
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the stack instance to get
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getStack_response
Type:
Show Source
object
-
instance(optional):
object instance
The stack instance
-
name(optional):
string
Name of the stack instance
-
notes(optional):
string
Notes for the stack instance
-
settings(optional):
object settings
Configuration settings for the stack instance
-
styles(optional):
object styles
Style settings for the stack instance
Nested Schema : instance
Type:
object
The stack instance
Show Source
-
descriptor(optional):
object descriptor
The stack descriptor associatged with the stack instance
-
displayName(optional):
string
Display name for the stack instance
-
id(optional):
string
Stack instance ID
-
nextButton(optional):
string
Label for 'next' button
-
previousButton(optional):
string
Label for 'previous button
-
repositoryId(optional):
string
Repository ID for stack instance
-
usingCodeView(optional):
boolean
Whether using code view
Nested Schema : settings
Type:
object
Configuration settings for the stack instance
Show Source
-
showButtons(optional):
boolean
Whether to show Next and Previous button controls
-
showStepNames(optional):
boolean
Whether to show step names
Nested Schema : styles
Type:
object
Style settings for the stack instance
Show Source
-
@activeBackgroundColor(optional):
string
Background color for the active step
-
@activeTextColor(optional):
string
Text color for the active step
-
@completedBackgroundColor(optional):
string
Background color for completed steps
-
@completedTextColor(optional):
string
Text color for completed steps
-
@remainingBackgroundColor(optional):
string
Background color for remaining steps
-
@remainingTextColor(optional):
string
Text color for remaining steps
-
@showPreviousButton(optional):
boolean
Whether to show the previous button
-
@stepNameAlignment(optional):
string
Alignment of step names
Nested Schema : descriptor
Type:
object
The stack descriptor associatged with the stack instance
Show Source
-
availableToAllPages(optional):
boolean
Whether stack descriptor is available to all pages
-
configurable(optional):
boolean
Whether stack is configurable
-
displayName(optional):
string
Display name of the stack descriptor
-
id(optional):
string
ID of the stack instance
-
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
-
nextButton(optional):
string
The label for the 'next' button
-
pageTypes(optional):
array pageTypes
Array of page types that the stack descriptor can be used on
-
previousButton(optional):
string
Label for the 'previous' button
-
regions(optional):
array regions
List of regions for stack steps
-
repositoryId(optional):
string
Repository ID of the stack descriptor
-
stackType(optional):
string
Type of stack
-
version(optional):
integer
Version of the stack descriptor
Nested Schema : pageTypes
Type:
array
Array of page types that the stack descriptor can be used on
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)
{
"settings":{
"showButtons":true,
"showStepNames":true
},
"instance":{
"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"
},
"notes":"",
"name":"Progress Tracker",
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/stacks/re100002"
}
],
"styles":{
"@remainingTextColor":"#000000",
"@completedBackgroundColor":"#A3C9EB",
"@showPreviousButton":true,
"@completedTextColor":"#000000",
"@activeBackgroundColor":"#195D8E",
"@activeTextColor":"#FFFFFF",
"@stepNameAlignment":"center",
"@remainingBackgroundColor":"#EEEEEE"
}
}
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