1. REST API for Oracle Commerce Cloud 21B
  2. Tasks
  3. Admin
  4. Stacks

getStack

get

/ccadmin/v1/stacks/{id}

Get Stack. Get a stack based on ID

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getStack_response
Type: object
Show Source
Nested Schema : instance
Type: object
The stack instance
Show Source
Nested Schema : settings
Type: object
Configuration settings for the stack instance
Show Source
Nested Schema : styles
Type: object
Style settings for the stack instance
Show Source
Nested Schema : descriptor
Type: object
The stack descriptor associatged with the stack instance
Show Source
Nested Schema : pageTypes
Type: array
Array of page types that the stack descriptor can be used on
Show Source
Nested Schema : regions
Type: array
List of regions for stack steps
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
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
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top