Jump to

• Request
• Response

listStacks

get

/ccadmin/v1/stacks

List Stacks. List all the stacks by ID

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listStacks_response

Type: object

Show Source

• items(optional): array items
  List of stack instances

{
    "properties":{
        "items":{
            "description":"List of stack instances",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "nextButton":{
                        "description":"Label for 'next' button",
                        "type":"string"
                    },
                    "previousButton":{
                        "description":"Label for 'previous' button",
                        "type":"string"
                    },
                    "usingCodeView":{
                        "description":"Whether using code view",
                        "type":"boolean"
                    },
                    "displayName":{
                        "description":"Display name for stack instance",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"Repository ID of stack instance",
                        "type":"string"
                    },
                    "descriptor":{
                        "description":"Stack descriptor",
                        "type":"object",
                        "properties":{
                            "isLatestVersion":{
                                "description":"Whether this is the latest version of the stack descriptor",
                                "type":"boolean"
                            },
                            "previousButton":{
                                "description":"Label for the 'previous' button",
                                "type":"string"
                            },
                            "regions":{
                                "description":"List of stack step regions",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "repositoryId":{
                                            "description":"Repository ID of stack step region",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "displayName":{
                                "description":"Display name of the stack descriptor",
                                "type":"string"
                            },
                            "availableToAllPages":{
                                "description":"Whether stack descriptor is available to all pages",
                                "type":"boolean"
                            },
                            "minWidth":{
                                "description":"The minimum width of the stack region",
                                "type":"integer"
                            },
                            "version":{
                                "description":"Stack version",
                                "type":"integer"
                            },
                            "nextButton":{
                                "description":"Label for the 'next' button",
                                "type":"string"
                            },
                            "latestVersion":{
                                "description":"The latest version of the stack descriptor",
                                "type":"integer"
                            },
                            "repositoryId":{
                                "description":"Repository ID of the stack descriptor",
                                "type":"string"
                            },
                            "id":{
                                "description":"ID of the stack descriptor",
                                "type":"string"
                            },
                            "pageTypes":{
                                "description":"List of page types that the stack descriptor can be applied to",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "repositoryId":{
                                            "description":"Page type repository ID",
                                            "type":"string"
                                        },
                                        "alias":{
                                            "description":"Page type alias",
                                            "type":"string"
                                        },
                                        "id":{
                                            "description":"Page type ID",
                                            "type":"string"
                                        },
                                        "shortName":{
                                            "description":"Page type name",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "stackType":{
                                "description":"Type of stack",
                                "type":"string"
                            },
                            "configurable":{
                                "description":"Whether the stack descriptor is configurable",
                                "type":"boolean"
                            }
                        }
                    },
                    "id":{
                        "description":"ID of stack instance",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

List of stack instances

Show Source

• Array of: object items

{
    "description":"List of stack instances",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "nextButton":{
                "description":"Label for 'next' button",
                "type":"string"
            },
            "previousButton":{
                "description":"Label for 'previous' button",
                "type":"string"
            },
            "usingCodeView":{
                "description":"Whether using code view",
                "type":"boolean"
            },
            "displayName":{
                "description":"Display name for stack instance",
                "type":"string"
            },
            "repositoryId":{
                "description":"Repository ID of stack instance",
                "type":"string"
            },
            "descriptor":{
                "description":"Stack descriptor",
                "type":"object",
                "properties":{
                    "isLatestVersion":{
                        "description":"Whether this is the latest version of the stack descriptor",
                        "type":"boolean"
                    },
                    "previousButton":{
                        "description":"Label for the 'previous' button",
                        "type":"string"
                    },
                    "regions":{
                        "description":"List of stack step regions",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "repositoryId":{
                                    "description":"Repository ID of stack step region",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "displayName":{
                        "description":"Display name of the stack descriptor",
                        "type":"string"
                    },
                    "availableToAllPages":{
                        "description":"Whether stack descriptor is available to all pages",
                        "type":"boolean"
                    },
                    "minWidth":{
                        "description":"The minimum width of the stack region",
                        "type":"integer"
                    },
                    "version":{
                        "description":"Stack version",
                        "type":"integer"
                    },
                    "nextButton":{
                        "description":"Label for the 'next' button",
                        "type":"string"
                    },
                    "latestVersion":{
                        "description":"The latest version of the stack descriptor",
                        "type":"integer"
                    },
                    "repositoryId":{
                        "description":"Repository ID of the stack descriptor",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of the stack descriptor",
                        "type":"string"
                    },
                    "pageTypes":{
                        "description":"List of page types that the stack descriptor can be applied to",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "repositoryId":{
                                    "description":"Page type repository ID",
                                    "type":"string"
                                },
                                "alias":{
                                    "description":"Page type alias",
                                    "type":"string"
                                },
                                "id":{
                                    "description":"Page type ID",
                                    "type":"string"
                                },
                                "shortName":{
                                    "description":"Page type name",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "stackType":{
                        "description":"Type of stack",
                        "type":"string"
                    },
                    "configurable":{
                        "description":"Whether the stack descriptor is configurable",
                        "type":"boolean"
                    }
                }
            },
            "id":{
                "description":"ID of stack instance",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• descriptor(optional): object descriptor
  Stack descriptor
• displayName(optional): string
  Display name for stack instance
• id(optional): string
  ID of stack instance
• nextButton(optional): string
  Label for 'next' button
• previousButton(optional): string
  Label for 'previous' button
• repositoryId(optional): string
  Repository ID of stack instance
• usingCodeView(optional): boolean
  Whether using code view

{
    "type":"object",
    "properties":{
        "nextButton":{
            "description":"Label for 'next' button",
            "type":"string"
        },
        "previousButton":{
            "description":"Label for 'previous' button",
            "type":"string"
        },
        "usingCodeView":{
            "description":"Whether using code view",
            "type":"boolean"
        },
        "displayName":{
            "description":"Display name for stack instance",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of stack instance",
            "type":"string"
        },
        "descriptor":{
            "description":"Stack descriptor",
            "type":"object",
            "properties":{
                "isLatestVersion":{
                    "description":"Whether this is the latest version of the stack descriptor",
                    "type":"boolean"
                },
                "previousButton":{
                    "description":"Label for the 'previous' button",
                    "type":"string"
                },
                "regions":{
                    "description":"List of stack step regions",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"Repository ID of stack step region",
                                "type":"string"
                            }
                        }
                    }
                },
                "displayName":{
                    "description":"Display name of the stack descriptor",
                    "type":"string"
                },
                "availableToAllPages":{
                    "description":"Whether stack descriptor is available to all pages",
                    "type":"boolean"
                },
                "minWidth":{
                    "description":"The minimum width of the stack region",
                    "type":"integer"
                },
                "version":{
                    "description":"Stack version",
                    "type":"integer"
                },
                "nextButton":{
                    "description":"Label for the 'next' button",
                    "type":"string"
                },
                "latestVersion":{
                    "description":"The latest version of the stack descriptor",
                    "type":"integer"
                },
                "repositoryId":{
                    "description":"Repository ID of the stack descriptor",
                    "type":"string"
                },
                "id":{
                    "description":"ID of the stack descriptor",
                    "type":"string"
                },
                "pageTypes":{
                    "description":"List of page types that the stack descriptor can be applied to",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"Page type repository ID",
                                "type":"string"
                            },
                            "alias":{
                                "description":"Page type alias",
                                "type":"string"
                            },
                            "id":{
                                "description":"Page type ID",
                                "type":"string"
                            },
                            "shortName":{
                                "description":"Page type name",
                                "type":"string"
                            }
                        }
                    }
                },
                "stackType":{
                    "description":"Type of stack",
                    "type":"string"
                },
                "configurable":{
                    "description":"Whether the stack descriptor is configurable",
                    "type":"boolean"
                }
            }
        },
        "id":{
            "description":"ID of stack instance",
            "type":"string"
        }
    }
}

Nested Schema : descriptor

Type: object

Stack descriptor

Show Source

• availableToAllPages(optional): boolean
  Whether stack descriptor is available to all pages
• configurable(optional): boolean
  Whether the stack descriptor is configurable
• displayName(optional): string
  Display name of 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
  The minimum width of the stack region
• nextButton(optional): string
  Label for the 'next' button
• pageTypes(optional): array pageTypes
  List of page types that the stack descriptor can be applied to
• previousButton(optional): string
  Label for the 'previous' button
• regions(optional): array regions
  List of stack step regions
• repositoryId(optional): string
  Repository ID of the stack descriptor
• stackType(optional): string
  Type of stack
• version(optional): integer
  Stack version

{
    "description":"Stack descriptor",
    "type":"object",
    "properties":{
        "isLatestVersion":{
            "description":"Whether this is the latest version of the stack descriptor",
            "type":"boolean"
        },
        "previousButton":{
            "description":"Label for the 'previous' button",
            "type":"string"
        },
        "regions":{
            "description":"List of stack step regions",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository ID of stack step region",
                        "type":"string"
                    }
                }
            }
        },
        "displayName":{
            "description":"Display name of the stack descriptor",
            "type":"string"
        },
        "availableToAllPages":{
            "description":"Whether stack descriptor is available to all pages",
            "type":"boolean"
        },
        "minWidth":{
            "description":"The minimum width of the stack region",
            "type":"integer"
        },
        "version":{
            "description":"Stack version",
            "type":"integer"
        },
        "nextButton":{
            "description":"Label for the 'next' button",
            "type":"string"
        },
        "latestVersion":{
            "description":"The latest version of the stack descriptor",
            "type":"integer"
        },
        "repositoryId":{
            "description":"Repository ID of the stack descriptor",
            "type":"string"
        },
        "id":{
            "description":"ID of the stack descriptor",
            "type":"string"
        },
        "pageTypes":{
            "description":"List of page types that the stack descriptor can be applied to",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Page type repository ID",
                        "type":"string"
                    },
                    "alias":{
                        "description":"Page type alias",
                        "type":"string"
                    },
                    "id":{
                        "description":"Page type ID",
                        "type":"string"
                    },
                    "shortName":{
                        "description":"Page type name",
                        "type":"string"
                    }
                }
            }
        },
        "stackType":{
            "description":"Type of stack",
            "type":"string"
        },
        "configurable":{
            "description":"Whether the stack descriptor is configurable",
            "type":"boolean"
        }
    }
}

Nested Schema : pageTypes

Type: array

List of page types that the stack descriptor can be applied to

Show Source

• Array of: object items

{
    "description":"List of page types that the stack descriptor can be applied to",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"Page type repository ID",
                "type":"string"
            },
            "alias":{
                "description":"Page type alias",
                "type":"string"
            },
            "id":{
                "description":"Page type ID",
                "type":"string"
            },
            "shortName":{
                "description":"Page type name",
                "type":"string"
            }
        }
    }
}

Nested Schema : regions

Type: array

List of stack step regions

Show Source

• Array of: object items

{
    "description":"List of stack step regions",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"Repository ID of stack step region",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Page type repository ID",
            "type":"string"
        },
        "alias":{
            "description":"Page type alias",
            "type":"string"
        },
        "id":{
            "description":"Page type ID",
            "type":"string"
        },
        "shortName":{
            "description":"Page type name",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId(optional): string
  Repository ID of stack step region

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID of stack step region",
            "type":"string"
        }
    }
}

Example Response (application/json)

[
    {
        "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"
    }
]

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