Get Dataset

GET

https://api.gov.nominal.io/api/catalog/v1/datasets-simple/:datasetUuid

GET

/api/catalog/v1/datasets-simple/:datasetUuid

1 curl https://api.gov.nominal.io/api/catalog/v1/datasets-simple/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "rid": "rid",
3   "name": "name",
4   "originMetadata": {
5     "path": "path",
6     "xSeriesIsAbsolute": true,
7     "schemaDirectivePath": "schemaDirectivePath",
8     "xSeriesColumnName": "xSeriesColumnName",
9     "xSeriesTimeUnit": "DAYS",
10     "timestampMetadata": {
11       "seriesName": "seriesName",
12       "timestampType": {
13         "type": "relative",
14         "relative": {
15           "timeUnit": "DAYS",
16           "offset": "2024-01-15T09:30:00Z"
17         }
18       }
19     },
20     "channelConfig": {
21       "prefixTreeDelimiter": "prefixTreeDelimiter"
22     }
23   },
24   "properties": {
25     "properties": "properties"
26   },
27   "labels": [
28     "labels"
29   ],
30   "timestampType": "ABSOLUTE",
31   "allowStreaming": true,
32   "handle": {
33     "type": "s3",
34     "s3": {
35       "bucket": "bucket",
36       "key": "key"
37     }
38   },
39   "description": "description",
40   "bounds": {
41     "start": {
42       "seconds": 1000000,
43       "nanos": 1000000,
44       "picos": 1
45     },
46     "end": {
47       "seconds": 1000000,
48       "nanos": 1000000,
49       "picos": 1
50     },
51     "type": "ABSOLUTE"
52   }
53 }

Path parameters

datasetUuidUUIDRequired

Response

This endpoint returns an object.

ridstring

namestring

originMetadataobject

propertiesmap from strings to strings

labelsset of strings

timestampTypeenum

Allowed values:

allowStreamingboolean

handleobjectOptional

descriptionstringOptional

boundsobjectOptional

Path parameters

Headers

Response