Retrieving a Dataset via REST API

Overview

Description	Retrieve the dataset of a given dataset ID.
Resource Path	`/api/datasets/{datasetId}`
HTTP Method	GET
Response Format	application/json

Sample cURL command

By default, <ML_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
By default, <ML_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

Example cURL command

curl -H "Content-Type: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4=" -v https://localhost:9443/api/datasets/1 -k

Example

GET https://localhost:9443/api/datasets/{datasetId}

Sample output

{
  "containsHeader": false,
  "dataSourceType": "file",
  "dataTargetType": "file",
  "comments": "Pima Indians Diabetes Dataset",
  "tenantId": -1234,
  "sourcePath": null,
  "dataType": "csv",
  "name": "Pima Indians Diabetes",
  "id": 1,
  "version": null,
  "userName": "admin",
  "status": "Available"
}

REST API response

HTTP status code

200, 404 or 500

For descriptions of the HTTP status codes, see HTTP Status Codes.