Sample Dataset Definition

Dataset should be uploaded as a multipart/form-data request. Therefore, you need not pass a JSON definition payload in the request. However, you can set the required parameters in the request. For information on those parameters, see Uploading a Dataset via REST API.

The configurations included in a sample dataset definition JSON file are as follows.

{
  "name": "seeds",
  "id": 2,
  "tenantId": -1234,
  "comments": "Seeds Dataset",
  "dataType": "CSV",
  "userName": "admin",
  "version": "1.0.0",
  "sourcePath": null,
  "dataSourceType": "file",
  "dataTargetType": "file",
  "containsHeader": true
}

Parameter definitions

The definitions of the parameters in the above sample project definition JSON file are as follows.

Parameter	Description	Required	Default value	Example
name	A unique name to identify the dataset	Yes	None	seeds
`id`	A unique ID to identify the dataset	Yes	None	2
tenantId	A unique ID to identify the tenant	No	None	-1234
comments	Comments on the dataset.	No	None	Seeds Dataset
dataType	Format of the dataset (CSV/TSV)	Yes	None	CSV
userName	User name of the account of the logged in user	Yes	None	admin
version	Version of the dataset,	Yes	None	1.0.0
sourcePath	If source type is HDFS, this should hold the absolute URI of the dataset file and if source type is BAM,this should be in <table_name>:<col_1_name>,<col_1_type>;<col_2_name>,<col_2_type> format.	No	None	null
dataSourceType	Storage type of the source of the dataset (file/HDFS/WSO2 DAS)	Yes	file	file
dataTargetType	Storage type of the server side copy of the dataset (file/HDFS)	Yes	file	file
containsHeader	Whether the dataset contains a header row or not.	Yes	false	true