Jump to

• Request
• Response

updateHiddenStackTypes

put

/ccadmin/v1/stackDescriptors/hidden

Update Hidden Stack Types. Set whether a Stack Type will be visible in the Site Studio component library

Request

Supported Media Types

• application/json

Body ()

Root Schema : updateHiddenStackTypes_request

Show Source

{
    "properties":{
    },
    "example":{
        "stackDescriptors":[
            {
                "hiddenFromSiteStudio":true,
                "stackType":"progressTracker"
            }
        ]
    }
}

Example:

{
    "stackDescriptors":[
        {
            "hiddenFromSiteStudio":true,
            "stackType":"progressTracker"
        }
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateHiddenStackTypes_response

Show Source

{
    "properties":{
    }
}

Example Response (application/json)

{
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/stackDescriptors/hidden"
        }
    ],
    "autoWrap":true,
    "items":[
        {
            "regions":[
                {
                    "repositoryId":"progressTrackerStageOne"
                },
                {
                    "repositoryId":"progressTrackerStageTwo"
                },
                {
                    "repositoryId":"progressTrackerStageThree"
                }
            ],
            "isLatestVersion":true,
            "previousButton":"Previous",
            "displayName":"Progress Tracker",
            "availableToAllPages":false,
            "minWidth":1,
            "version":1,
            "nextButton":"Next",
            "latestVersion":1,
            "repositoryId":"progressTracker",
            "hiddenFromSiteStudio":true,
            "id":"progressTracker",
            "pageTypes":[
                {
                    "repositoryId":"checkoutPageType",
                    "alias":"/checkout",
                    "id":"checkoutPageType",
                    "shortName":"checkout"
                }
            ],
            "stackType":"progressTracker",
            "configurable":true
        }
    ]
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top