Jump to

• Request
• Response

getConfigDefinitionForComponent

get

/ccadmin/v1/applications/{applicationId}/components/{componentId}/config

Gets the configuration definition for a component

Request

Supported Media Types

• application/json

Path Parameters

• applicationId(required): string
  The ID of the application.
• componentId(required): string
  The ID of the component.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getConfigDefinitionForComponent_response

Type: object

Show Source

• repositoryId: string
  The component's repository ID.
• values: array values
  Configuration Settings

{
    "properties":{
        "values":{
            "description":"Configuration Settings",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "placeHolders":{
                        "description":"Place holdlers",
                        "type":"string"
                    },
                    "noOfColumns":{
                        "description":"Number of columns",
                        "type":"integer"
                    },
                    "helpText":{
                        "description":"Help text",
                        "type":"string"
                    },
                    "defaultValue":{
                        "description":"Default value for the configuration setting",
                        "type":"string"
                    },
                    "minLength":{
                        "description":"Minimum length",
                        "type":"integer"
                    },
                    "addMoreRowsResourceId":{
                        "description":"ID of resource to use for 'add more rows' message",
                        "type":"string"
                    },
                    "label":{
                        "description":"Label for the configuration setting",
                        "type":"string"
                    },
                    "required":{
                        "description":"Denotes if this is a required setting",
                        "type":"string"
                    },
                    "dataKey":{
                        "description":"Data key",
                        "type":"string"
                    },
                    "displayOnInstances":{
                        "description":"Controls whether to display setting on instances",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"Repository ID of the configuration setting",
                        "type":"string"
                    },
                    "name":{
                        "description":"Name of the configuration setting",
                        "type":"string"
                    },
                    "maxLengths":{
                        "description":"Maximum lengths",
                        "type":"string"
                    },
                    "options":{
                        "description":"Configuration options",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "label":{
                                    "description":"Option label",
                                    "type":"string"
                                },
                                "value":{
                                    "description":"Option value",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "regexText":{
                        "description":"Regular expression text",
                        "type":"string"
                    },
                    "displayAsCheckboxes":{
                        "description":"Whether to display as checkboxes",
                        "type":"boolean"
                    },
                    "maxLength":{
                        "description":"Maximum length",
                        "type":"integer"
                    }
                }
            }
        },
        "repositoryId":{
            "description":"The component's repository ID.",
            "type":"string"
        }
    }
}

Nested Schema : values

Type: array

Configuration Settings

Show Source

• Array of: object items

{
    "description":"Configuration Settings",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "placeHolders":{
                "description":"Place holdlers",
                "type":"string"
            },
            "noOfColumns":{
                "description":"Number of columns",
                "type":"integer"
            },
            "helpText":{
                "description":"Help text",
                "type":"string"
            },
            "defaultValue":{
                "description":"Default value for the configuration setting",
                "type":"string"
            },
            "minLength":{
                "description":"Minimum length",
                "type":"integer"
            },
            "addMoreRowsResourceId":{
                "description":"ID of resource to use for 'add more rows' message",
                "type":"string"
            },
            "label":{
                "description":"Label for the configuration setting",
                "type":"string"
            },
            "required":{
                "description":"Denotes if this is a required setting",
                "type":"string"
            },
            "dataKey":{
                "description":"Data key",
                "type":"string"
            },
            "displayOnInstances":{
                "description":"Controls whether to display setting on instances",
                "type":"string"
            },
            "repositoryId":{
                "description":"Repository ID of the configuration setting",
                "type":"string"
            },
            "name":{
                "description":"Name of the configuration setting",
                "type":"string"
            },
            "maxLengths":{
                "description":"Maximum lengths",
                "type":"string"
            },
            "options":{
                "description":"Configuration options",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "label":{
                            "description":"Option label",
                            "type":"string"
                        },
                        "value":{
                            "description":"Option value",
                            "type":"string"
                        }
                    }
                }
            },
            "regexText":{
                "description":"Regular expression text",
                "type":"string"
            },
            "displayAsCheckboxes":{
                "description":"Whether to display as checkboxes",
                "type":"boolean"
            },
            "maxLength":{
                "description":"Maximum length",
                "type":"integer"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• addMoreRowsResourceId: string
  ID of resource to use for 'add more rows' message
• dataKey: string
  Data key
• defaultValue: string
  Default value for the configuration setting
• displayAsCheckboxes: boolean
  Whether to display as checkboxes
• displayOnInstances: string
  Controls whether to display setting on instances
• helpText: string
  Help text
• label: string
  Label for the configuration setting
• maxLength: integer
  Maximum length
• maxLengths: string
  Maximum lengths
• minLength: integer
  Minimum length
• name: string
  Name of the configuration setting
• noOfColumns: integer
  Number of columns
• options: array options
  Configuration options
• placeHolders: string
  Place holdlers
• regexText: string
  Regular expression text
• repositoryId: string
  Repository ID of the configuration setting
• required: string
  Denotes if this is a required setting

{
    "type":"object",
    "properties":{
        "placeHolders":{
            "description":"Place holdlers",
            "type":"string"
        },
        "noOfColumns":{
            "description":"Number of columns",
            "type":"integer"
        },
        "helpText":{
            "description":"Help text",
            "type":"string"
        },
        "defaultValue":{
            "description":"Default value for the configuration setting",
            "type":"string"
        },
        "minLength":{
            "description":"Minimum length",
            "type":"integer"
        },
        "addMoreRowsResourceId":{
            "description":"ID of resource to use for 'add more rows' message",
            "type":"string"
        },
        "label":{
            "description":"Label for the configuration setting",
            "type":"string"
        },
        "required":{
            "description":"Denotes if this is a required setting",
            "type":"string"
        },
        "dataKey":{
            "description":"Data key",
            "type":"string"
        },
        "displayOnInstances":{
            "description":"Controls whether to display setting on instances",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of the configuration setting",
            "type":"string"
        },
        "name":{
            "description":"Name of the configuration setting",
            "type":"string"
        },
        "maxLengths":{
            "description":"Maximum lengths",
            "type":"string"
        },
        "options":{
            "description":"Configuration options",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "label":{
                        "description":"Option label",
                        "type":"string"
                    },
                    "value":{
                        "description":"Option value",
                        "type":"string"
                    }
                }
            }
        },
        "regexText":{
            "description":"Regular expression text",
            "type":"string"
        },
        "displayAsCheckboxes":{
            "description":"Whether to display as checkboxes",
            "type":"boolean"
        },
        "maxLength":{
            "description":"Maximum length",
            "type":"integer"
        }
    }
}

Nested Schema : options

Type: array

Configuration options

Show Source

• Array of: object items

{
    "description":"Configuration options",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "label":{
                "description":"Option label",
                "type":"string"
            },
            "value":{
                "description":"Option value",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• label: string
  Option label
• value: string
  Option value

{
    "type":"object",
    "properties":{
        "label":{
            "description":"Option label",
            "type":"string"
        },
        "value":{
            "description":"Option value",
            "type":"string"
        }
    }
}

Example Response (values)

[
    {
        "placeHolders":null,
        "noOfColumns":1000,
        "helpText":"To override the default widget styling, enter a CSS class name.",
        "defaultValue":null,
        "minLength":0,
        "addMoreRowsResourceId":null,
        "label":"CSS Class",
        "type":"text",
        "required":false,
        "dataKey":null,
        "displayOnInstances":null,
        "repositoryId":"201520",
        "name":"cssOverride",
        "maxLengths":null,
        "options":[
        ],
        "regexText":null,
        "displayAsCheckboxes":false,
        "maxLength":1000
    },
    {
        "placeHolders":null,
        "noOfColumns":1000,
        "helpText":null,
        "defaultValue":"
Some Web Content Text
",
        "minLength":0,
        "addMoreRowsResourceId":null,
        "label":"Web Content",
        "type":"webContent",
        "required":true,
        "dataKey":null,
        "displayOnInstances":null,
        "repositoryId":"201521",
        "name":"webContent",
        "maxLengths":null,
        "options":[
        ],
        "regexText":null,
        "displayAsCheckboxes":false,
        "maxLength":1000
    }
]

Example Response (repositoryId)

100739

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