| Property Name | Value | Description | Required | Notes |
|---|---|---|---|---|
| name | string | A name of the dataset | Yes | |
| slug | string | Slug-like string of the dataset name | No | Autogenerated |
| type | string | The type of the dataset | No | |
| application | string | The application the dataset belongs to | No | Autogenerated |
| dataPath | string | Path of the data in document datasets | No | |
| attributesPath | string | Attributes to import | No | |
| connectorType | string | The type of connector of the dataset | Yes | Valid connectorTypes values ["rest", "document", "wms"] |
| provider | string | The dataset connector provider | Yes | Valid provider values: rest -> ["cartodb", "featureservice", "gee", "bigquery", "rasdaman", "nexgddp"]; document -> ["csv", "json", "tsv", "xml"]; wms -> ["wms"] |
| userId | string | The userId of the owner of the dataset | No | |
| connectorUrl | string | A valid url where the data is stored | No | Required when the dataset connectorType is rest. |
| tableName | string | The name of the actual or generated table. | No | Autogenerated |
| status | string | No | ||
| overwrite | boolean | No | ||
| verified | boolean | No | ||
| errorMessage | string | No | ||
| published | boolean | No | ||
| sandbox | boolean | No | ||
| env | string | No | ||
| geoInfo | boolean | No | ||
| protected | boolean | No | ||
| taskId | string | No | ||
| subscribable | nested object | No | ||
| blockchain | nested object | |||
| blockchain.id | string | No | Autogenerated | |
| blockchain.hash | string | No | Autogenerated | |
| blockchain.time | string | No | Autogenerated | |
| blockchain.backupUrl | string | No | Autogenerated | |
| legend | nested object | |||
| legend.lat | string | No | ||
| legend.long | string | No | ||
| legend.date | list | No | List of string values | |
| legend.region | list | No | List of string values | |
| legend.country | list | No | List of string values | |
| legend.nested | list | No | List of string values | |
| clonedHost | nested object | |||
| clonedHost.hostProvider | string | No | Autogenerated | |
| clonedHost.hostUrl | string | No | Autogenerated | |
| clonedHost.hostId | string | No | Autogenerated | |
| clonedHost.hostType | string | No | Autogenerated | |
| clonedHost.hostPath | string | No | Autogenerated | |
| createdAt | string | No | Date value | |
| updatedAt | string | No | Date Value |
GET: /v1/dataset
POST: /v1/dataset
GET: /v1/dataset/:dataset
PATCH: /v1/dataset/:dataset
DELETE: /v1/dataset/:dataset
POST: /v1/dataset/find-by-ids
POST: /v1/dataset/upload
GET: /v1/dataset/:dataset/clone
You will need:
- Docker Docker
- Docker Compose Docker Compose
Once you have both technologies installed locally, run the following:
./dataset.sh develop
In order to emulate the production environment (API Gateway & Microservice pattern) you will need to download the API Gateway and have it running locally.
Check this out -> Control Tower (API Gateway)
Or just run the following.
git clone https://github.com/control-tower/control-tower
./controlTower.sh develop
If you want to make authenticated request, just grab a valid JWT Token from the Control Tower Github Repository. Control Tower (API Gateway)