Jump to

• Request
• Response

getConfigDefinitionForStackDescriptor

get

/ccadmin/v1/stackDescriptors/{id}/config

Get Config Definition For Stack Descriptor. Returns the Config Definition For Stack Descriptor

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  the stack descriptor ID.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getConfigDefinitionForStackDescriptor_response

Type: object

Show Source

• repositoryId: string
  description of repositoryId
• values: array values
  description of values

{
    "properties":{
        "values":{
            "description":"description of values",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "helpText":{
                        "description":"description of helpText",
                        "type":"string"
                    },
                    "defaultValue":{
                        "description":"description of defaultValue",
                        "type":"string"
                    },
                    "minLength":{
                        "description":"description of minLength",
                        "type":"integer"
                    },
                    "label":{
                        "description":"description of label",
                        "type":"string"
                    },
                    "type":{
                        "description":"description of type",
                        "type":"string"
                    },
                    "required":{
                        "description":"description of required",
                        "type":"boolean"
                    },
                    "displayOnInstances":{
                        "description":"description of displayOnInstances",
                        "type":"boolean"
                    },
                    "name":{
                        "description":"description of name",
                        "type":"string"
                    },
                    "options":{
                        "description":"description of options",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "repositoryId":{
                        "description":"description of repositoryId",
                        "type":"string"
                    },
                    "regexText":{
                        "description":"description of regexText",
                        "type":"string"
                    },
                    "displayAsCheckboxes":{
                        "description":"description of displayAsCheckboxes",
                        "type":"boolean"
                    },
                    "maxLength":{
                        "description":"description of maxLength",
                        "type":"integer"
                    }
                }
            }
        },
        "repositoryId":{
            "description":"description of repositoryId",
            "type":"string"
        }
    }
}

Nested Schema : values

Type: array

description of values

Show Source

• Array of: object items

{
    "description":"description of values",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "helpText":{
                "description":"description of helpText",
                "type":"string"
            },
            "defaultValue":{
                "description":"description of defaultValue",
                "type":"string"
            },
            "minLength":{
                "description":"description of minLength",
                "type":"integer"
            },
            "label":{
                "description":"description of label",
                "type":"string"
            },
            "type":{
                "description":"description of type",
                "type":"string"
            },
            "required":{
                "description":"description of required",
                "type":"boolean"
            },
            "displayOnInstances":{
                "description":"description of displayOnInstances",
                "type":"boolean"
            },
            "name":{
                "description":"description of name",
                "type":"string"
            },
            "options":{
                "description":"description of options",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "repositoryId":{
                "description":"description of repositoryId",
                "type":"string"
            },
            "regexText":{
                "description":"description of regexText",
                "type":"string"
            },
            "displayAsCheckboxes":{
                "description":"description of displayAsCheckboxes",
                "type":"boolean"
            },
            "maxLength":{
                "description":"description of maxLength",
                "type":"integer"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• defaultValue: string
  description of defaultValue
• displayAsCheckboxes: boolean
  description of displayAsCheckboxes
• displayOnInstances: boolean
  description of displayOnInstances
• helpText: string
  description of helpText
• label: string
  description of label
• maxLength: integer
  description of maxLength
• minLength: integer
  description of minLength
• name: string
  description of name
• options: array options
  description of options
• regexText: string
  description of regexText
• repositoryId: string
  description of repositoryId
• required: boolean
  description of required
• type: string
  description of type

{
    "type":"object",
    "properties":{
        "helpText":{
            "description":"description of helpText",
            "type":"string"
        },
        "defaultValue":{
            "description":"description of defaultValue",
            "type":"string"
        },
        "minLength":{
            "description":"description of minLength",
            "type":"integer"
        },
        "label":{
            "description":"description of label",
            "type":"string"
        },
        "type":{
            "description":"description of type",
            "type":"string"
        },
        "required":{
            "description":"description of required",
            "type":"boolean"
        },
        "displayOnInstances":{
            "description":"description of displayOnInstances",
            "type":"boolean"
        },
        "name":{
            "description":"description of name",
            "type":"string"
        },
        "options":{
            "description":"description of options",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "repositoryId":{
            "description":"description of repositoryId",
            "type":"string"
        },
        "regexText":{
            "description":"description of regexText",
            "type":"string"
        },
        "displayAsCheckboxes":{
            "description":"description of displayAsCheckboxes",
            "type":"boolean"
        },
        "maxLength":{
            "description":"description of maxLength",
            "type":"integer"
        }
    }
}

Nested Schema : options

Type: array

description of options

Show Source

• Array of: string

{
    "description":"description of options",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example Response (application/json)

{
    "values":[
        {
            "helpText":"Whether to show the step names",
            "defaultValue":"false",
            "minLength":0,
            "label":"Show Step names",
            "type":"checkbox",
            "required":false,
            "displayOnInstances":null,
            "name":"showStepNames",
            "options":[
            ],
            "repositoryId":"showStepNames",
            "regexText":null,
            "displayAsCheckboxes":false,
            "maxLength":1000
        },
        {
            "helpText":"Whether to show the \"Previous\" and \"Next\" buttons",
            "defaultValue":"true",
            "minLength":0,
            "label":"Show Buttons",
            "type":"checkbox",
            "required":false,
            "displayOnInstances":null,
            "name":"showButtons",
            "options":[
            ],
            "repositoryId":"showButtons",
            "regexText":null,
            "displayAsCheckboxes":false,
            "maxLength":1000
        }
    ],
    "repositoryId":"progressTracker",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/stackDescriptors/progressTracker/config"
        }
    ]
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "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: 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

{
    "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