...
The formats that RDS supports can be broken down into three categories, data (flat files), metadata (standards compliant metadata XML), and scripts (syntax to recreate the data in databases or statistical packages). To view the formats that are in each category use the category parameter. These lists of formats are designed to allow users to view and choose the format they would like, once they select the format they can retrieve the options that will need to be filled out for that format.
| Code Block |
|---|
|
http://host/rds/api/package/types?category=data |
...
| Code Block |
|---|
| title | Script Formats |
|---|
| collapse | true |
|---|
|
[
"SAS",
"SPSS",
"STATA",
"R",
"MATHEMATICA",
"STAT_TRANSFER",
"MYSQL",
"ORACLE",
"MS_SQL",
"HYPER_SQL",
"POSTGRES_SQL",
"MONET_DB",
"GOOGLE_BQ",
"GOOGLE_FUSION",
"SDA",
"VERTICA"
] |
Format Options
Once a format is selected the options available for that format can be retrieved by specifying the format type as follows.
| Code Block |
|---|
http://host/rds/api/package/types/{type} |
| Code Block |
|---|
| title | Get Fixed File Options |
|---|
|
http://host/rds/api/package/types/FIXED |
| Code Block |
|---|
|
{
"objectId": "47f2a70a-158c-4524-bd85-eee8880a5067",
"type": "FIXED",
"optionProperties": [
{
"description": "File name", // A human readable description of what this option is about
"enumValues": [], // If this option was of type "ENUM" the enumerated values could be found here
"label": "File name", // A label for the option, typically what will be shown to the user
"name": "fileName", // The property name, this must not change
"type": "TEXT", // designed to help those building a UI be able to decide the best input to use. Possible types are: BOOLEAN, DATE, ENUM, FILE, NUMBER, PASSWORD, TEXT, TEXTAREA
"value": "", // The value specified by the user, if there is a default value to begin with this will be filled out
"repeatable": false, // specifies if this option can be repeated
"required": true, // specifies if this option must be filled out
"readOnly": false // specifies if the value can be changed or not
}
]
} |