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/task-status/{taskId}
Query data source task status by task id.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| taskIdRequired | string | path | Task id, prefixed with "datasource:". For example: datasource:a10f7bbc-a416-46e5-ab19-e79e2293a88a |
Response
Status Code: 200
Success
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
Ƭ DatasetPluginErrorV2
Dataset plugin error model
| Name | Type | Description | Example |
|---|---|---|---|
| codeNullable | string | Error code | |
| messageNullable | string | Error message | |
| contextNullable | string | Error context | |
| innerError | DatasetPluginErrorV2 | ||
| extendedResultNullable | any | Extended result |
Ƭ WorkerTaskStatusViewModelV2
Worker task status view model.
| Name | Type | Description | Example |
|---|---|---|---|
| taskIdNullable | string | Task id. | |
| status | WorkerTaskStatusEnumV2 | ||
| statusTextNullable | string | Task status. | |
| startTimeNullable | ISO DateTime Sting | Start time. | |
| endTimeNullable | ISO DateTime Sting | End time. | |
| errorMessageNullable | string | Error message. | |
| errorMessageKeyNullable | string | Error message key. | |
| contextNullable | string | Context. | |
| extraInfoNullable | string | Extra info. |
Ƭ WorkerTaskStatusEnumV2
Enum:
StandbyRunningPrimaryTaskFinishedPrimaryTaskFaultedPrimaryTaskUserCancelledFinished
Task status.
* Standby - 0 - Standby.
* Running - 1 - Running.
* PrimaryTaskFinished - 2 - Primary task finished.
* PrimaryTaskFaulted - 3 - Primary task faulted.
* PrimaryTaskUserCancelled - 4 - Primary task was canceled by the user.
* Finished - 7 - Finished.
Ƭ 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 |