Get Dataset

GET

Path parameters

datasetUuidUUIDRequired

Response

This endpoint returns an object.

ridstring

namestring

originMetadataobject

propertiesmap from strings to strings

labelsset of strings

timestampTypeenum

Allowed values: ABSOLUTERELATIVEPENDING

handleobjectOptional

descriptionstringOptional

boundsobjectOptional

GET

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

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   "handle": {
32     "type": "s3",
33     "s3": {
34       "bucket": "bucket",
35       "key": "key"
36     }
37   },
38   "description": "description",
39   "bounds": {
40     "start": {
41       "seconds": 1000000,
42       "nanos": 1000000,
43       "picos": 1
44     },
45     "end": {
46       "seconds": 1000000,
47       "nanos": 1000000,
48       "picos": 1
49     },
50     "type": "ABSOLUTE"
51   }
52 }

Get Datasets

Up Next

Built with

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

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	"handle": {
32	"type": "s3",
33	"s3": {
34	"bucket": "bucket",
35	"key": "key"
36	}
37	},
38	"description": "description",
39	"bounds": {
40	"start": {
41	"seconds": 1000000,
42	"nanos": 1000000,
43	"picos": 1
44	},
45	"end": {
46	"seconds": 1000000,
47	"nanos": 1000000,
48	"picos": 1
49	},
50	"type": "ABSOLUTE"
51	}
52	}