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: string
the stack descriptor ID.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getConfigDefinitionForStackDescriptor_response
Type:
Show Source
object
-
repositoryId(optional):
string
description of repositoryId
-
values(optional):
array values
description of values
Nested Schema : items
Type:
Show Source
object
-
defaultValue(optional):
string
description of defaultValue
-
displayAsCheckboxes(optional):
boolean
description of displayAsCheckboxes
-
displayOnInstances(optional):
boolean
description of displayOnInstances
-
helpText(optional):
string
description of helpText
-
label(optional):
string
description of label
-
maxLength(optional):
integer
description of maxLength
-
minLength(optional):
integer
description of minLength
-
name(optional):
string
description of name
-
options(optional):
array options
description of options
-
regexText(optional):
string
description of regexText
-
repositoryId(optional):
string
description of repositoryId
-
required(optional):
boolean
description of required
-
type(optional):
string
description of type
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
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:
array
An 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