skip to main content
Hybrid Data Pipeline API reference : Management API : Data Sources API : Get data stores : category-definition Object
  

Try Now
category-definition Object

Purpose

Describes the category-definition details for a data store connectionType object.
The category-definition contains a list of options that can be set on a DataSource based on this data store. A data store can have one or more categories of options.

Syntax



{
category-definition
{
“name”: <category-name>,
“options”: [{option-definition)
]
}
}

category-definition Object Descriptions

Parameter
Valid Values
Required
name
The category name. The category can be anything the connectivity service defines, such as General, Advanced, Security, and OData.
Yes
options
An array of one or more option-definition objects. The option definition defines the option id, display name, data type, and other information to describe the option.
A option-definition object has the format:

{
"id": <option-id>,
"displayName": <display-name>,
"documentation": "<help-text>",
"required": (true | false),
"type": <option-data-type>,
"default": <default-value>,
"choices": [{choice-definition}
]
}
See option-definition Object for more information.
No

Related topics

*Get data stores
*connectionType-details Object
*option-definition Object
*choice-definition Object