getStack
get
/ccadmin/v1/stacks/{id}
Get Stack. Get a stack based on ID
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): 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:
object instance
The stack instance
-
name:
string
Name of the stack instance
-
notes:
string
Notes for the stack instance
-
settings:
object settings
Configuration settings for the stack instance
-
styles:
object styles
Style settings for the stack instance
Nested Schema : instance
Type:
objectThe stack instance
Show Source
-
descriptor:
object descriptor
The stack descriptor associatged with the stack instance
-
displayName:
string
Display name for the stack instance
-
id:
string
Stack instance ID
-
nextButton:
string
Label for 'next' button
-
previousButton:
string
Label for 'previous button
-
repositoryId:
string
Repository ID for stack instance
-
usingCodeView:
boolean
Whether using code view
Nested Schema : settings
Type:
objectConfiguration settings for the stack instance
Show Source
-
showButtons:
boolean
Whether to show Next and Previous button controls
-
showStepNames:
boolean
Whether to show step names
Nested Schema : styles
Type:
objectStyle settings for the stack instance
Show Source
-
@activeBackgroundColor:
string
Background color for the active step
-
@activeTextColor:
string
Text color for the active step
-
@completedBackgroundColor:
string
Background color for completed steps
-
@completedTextColor:
string
Text color for completed steps
-
@remainingBackgroundColor:
string
Background color for remaining steps
-
@remainingTextColor:
string
Text color for remaining steps
-
@showPreviousButton:
boolean
Whether to show the previous button
-
@stepNameAlignment:
string
Alignment of step names
Nested Schema : descriptor
Type:
objectThe stack descriptor associatged with the stack instance
Show Source
-
availableToAllPages:
boolean
Whether stack descriptor is available to all pages
-
configurable:
boolean
Whether stack is configurable
-
displayName:
string
Display name of the stack descriptor
-
id:
string
ID of the stack instance
-
isLatestVersion:
boolean
Whether this is the latest version of the stack descriptor
-
latestVersion:
integer
The latest version of the stack descriptor
-
minWidth:
integer
The minimum width of the stack
-
nextButton:
string
The label for the 'next' button
-
pageTypes:
array pageTypes
Array of page types that the stack descriptor can be used on
-
previousButton:
string
Label for the 'previous' button
-
regions:
array regions
List of regions for stack steps
-
repositoryId:
string
Repository ID of the stack descriptor
-
stackType:
string
Type of stack
-
version:
integer
Version of the stack descriptor
Nested Schema : pageTypes
Type:
arrayArray of page types that the stack descriptor can be used on
Show Source
Nested Schema : items
Type:
Show Source
object-
alias:
string
Page type alias
-
id:
string
Page type ID
-
repositoryId:
string
Page type repository ID
-
shortName:
string
Page type name
Nested Schema : items
Type:
Show Source
object-
repositoryId:
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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code