updateStack
put
                    /ccadmin/v1/stacks/{id}
Update Stack. Update the settings of a stack
                Request
Supported Media Types
                - application/json
 
Path Parameters
                - 
                    id: string
                    
                    ID of the stack instance to be updated
 
Root Schema : updateStack_request
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            stackConfig(optional): 
            object  stackConfig
            
            Stack Configuration
 
Example:
    
    
{
    "stackConfig":{
        "notes":"The progress tracker stack",
        "name":"Progress Tracker Stack"
    }
}Nested Schema : stackConfig
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectStack Configuration
    
    
    
    
        Show Source
        - 
            name(optional): 
            string
            Stack name
 - 
            nextButton(optional): 
            string
            Label for 'next' button
 - 
            notes(optional): 
            string
            Stack notes
 - 
            previousButton(optional): 
            string
            Label for 'previous' button
 - 
            settings(optional): 
            object  settings
            
            Settings
 - 
            styles(optional): 
            object  styles
            
            Styles
 
Nested Schema : settings
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectSettings
    
    
    
    
        Show Source
        - 
            showButtons(optional): 
            boolean
            Show Buttons
 - 
            showStepNames(optional): 
            boolean
            Show Step Names
 
Nested Schema : styles
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectStyles
    
    
    
    
        Show Source
        - 
            @activeBackgroundColor(optional): 
            string
            Active Background Color
 - 
            @activeTextColor(optional): 
            string
            Active Text Color
 - 
            @completedBackgroundColor(optional): 
            string
            Completed Background Color
 - 
            @completedTextColor(optional): 
            string
            Completed Text Color
 - 
            @remainingBackgroundColor(optional): 
            string
            Remaining Background Color
 - 
            @remainingTextColor(optional): 
            string
            Remaining Text Color
 - 
            @showPreviousButton(optional): 
            boolean
            Show Previous Button
 - 
            @stepNameAlignment(optional): 
            string
            Step Name Alignment
 
Response
Supported Media Types
                - application/json
 
200 Response
Following model is returned when operation succeeds.
                
                
                    Root Schema : updateStack_response
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            descriptor(optional): 
            object  descriptor
            
            The stack descriptor associated 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 : descriptor
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectThe stack descriptor associated with the stack instance
    
    
    
    
        Show Source
        - 
            availableToAllPages(optional): 
            boolean
            Whether stack descriptor is available to all pages
 - 
            configurable(optional): 
            boolean
            Whether the stack is configurable
 - 
            displayName(optional): 
            string
            Display name for 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
            Minimum width for the stack
 - 
            nextButton(optional): 
            string
            Label for the 'next' button
 - 
            pageTypes(optional): 
            array  pageTypes
            
            Page types that the stack descriptor can be used with
 - 
            previousButton(optional): 
            string
            Label for 'previous' button
 - 
            regions(optional): 
            array  regions
            
            Stack step regions
 - 
            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: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayPage types that the stack descriptor can be used with
    
    
    
    
    
        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 for a stack step region
 
Example Response (application/json)
                    {
    "nextButton":"Next",
    "previousButton":"Previous",
    "usingCodeView":false,
    "displayName":"Progress Tracker Stack",
    "repositoryId":"re100002",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/stacks/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: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayAn 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