Datasource
Datasource
[GET] /api/v2/data/datasources/{id}/download
Download a datasource document.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| idRequired | string | path | document id. For example: 05bb029e-0d75-dc4d-671b-87299a4a6907 |
Response
Status Code: 200
Success
binary
Status Code: 400
Bad Request
Status Code: 404
Not Found
[GET] /api/v2/data/datasources/{id}/query
Query datasource.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| idRequired | string | path | datasource id |
| query | string | query | query |
| queryType | string | query | query type |
| format | string | query | format |
| UnknownTypeHandle | string | query | unknown type handle |
| MissParameterHandle | string | query | miss parameter handle |
| RowLimit | string | query | row limit |
Response
Status Code: 200
Success
binary
Status Code: 400
Bad Request
Status Code: 404
Not Found
[POST] /api/v2/data/datasources/{id}/query
Query datasource.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| idRequired | string | path | datasource id |
Request Schema
Response
Status Code: 200
Success
binary
Status Code: 400
Bad Request
Status Code: 404
Not Found
Models
Ƭ DatasetPluginError
| Name | Type | Description | Example |
|---|---|---|---|
| codeNullable | string | error code | |
| messageNullable | string | error message | |
| contextNullable | string | error context | |
| innerError | DatasetPluginError |
Ƭ QueryDataSourceRequestBody
Query data source request body
| Name | Type | Description | Example |
|---|---|---|---|
| datasourceParametersNullable | string | Datasource parameters | |
| queryNullable | string | Query | |
| queryTypeNullable | string | QueryType | |
| formatNullable | string | Format | |
| options | Options |
Ƭ Options
| Name | Type | Description | Example |
|---|---|---|---|
| unknownTypeHandleNullable | string | Unknown type handle | |
| missParameterHandleNullable | string | Miss parameter handle | |
| rowLimitNullable | string | Row limit |