You can obtain the following information about a dataset: number of attribute definitions, resource definitions, total resource count, and the list of data subset IDs.
Request line
GET baseURL/dbapi.do?action=retrieveDataset&dataset=<Datasetname>
Request body
Not applicable.
Request parameters
| Parameter | Type | Description |
|---|---|---|
| action | String | {retrieveDataset}
Specify the API function to be invoked. |
| dataset | String | Dataset name. From 2 to 32 alphanumeric, underscore (_), and hyphen (-) characters are allowed. |
Request example
GET /dbapi.do?action=retrieveDataset&dataset=defaultDs HTTP /1.1 Authorization:Basic ZnJlZDpmcmVk
Response body
{
"name":"",
"attributeDefCount":,
"resourceDefCount":,
"resourceCount":,
"dataSubset":
}
{
"code":"",
"error":""
}
Response example
{
"name":"defaultDs",
"attributeDefCount":100,
"resourceDefCount":150,
"resourceCount":1000,
"dataSubset":[
"usSubset",
"ukSubset",
"asSubset"
]
}
Response parameters
|
Parameter |
Type |
Description |
|---|---|---|
| name | String | Dataset name. |
| attributeDefCount | Integer | Number of attribute definitions for the given dataset. |
| resourceDefCount | Integer | Number of resource definitions for the given dataset. |
| resourceCount | Integer | Number of resources for the given dataset. |
| dataSubset | String | List of data subset IDs for the given dataset. |
| code | String | Eight-digit hexadecimal error code. |
| error | String | Error message. |
Status codes
|
Status code |
Message |
Description |
|---|---|---|
| 200 | OK | Request was successful, and the response body contains the requested log details. |
| 206 | PARTIAL CONTENT | Request is in progress, and the incremental content is available in the response body. |
| 400 | BAD REQUEST | Request URL or request body validation failed. Check the response body for details. |
| 401 | UNAUTHORIZED | Supplied authentication token is invalid or does not have the appropriate credentials to access the resource. |
| 404 | NOT FOUND | API server could not find a resource matching the request. |
| 405 | METHOD NOT ALLOWED | Request HTTP method is not allowed for the operation. |
| 500 | SERVER ERROR | API operation request failed. Check the response body for details. |
Response codes
The following table lists the common API response codes that might be generated through the standard API. If an error response is not listed, examine the HTTP status codes to determine the best method for addressing the issue.
| Response code | Message | Condition |
|---|---|---|
| 120000E4 | Mandatory parameter {dataset} is not specified. | The dataset parameter is not specified. |
| 120000E9 | License is not valid. | License is not uploaded, or the uploaded license is invalid or expired. |
| 120000E9 | Authorization needed. | Request is sent with an invalid authentication token. |
| 120000E4 | Dataset with {name}:[ds1] does not exist. | Request is sent for a dataset that does not exist. |
| 120000E0 | HTTP method [POST] is not supported for action [retrieveDataset]. | Request is sent with an HTTP method other than GET. |
| 120000E2 | Application encountered an internal error. | API server encountered an unknown error. |