Get Datasets

POST

Request

This endpoint expects an object.

datasetRidsset of stringsRequired

Response

This endpoint returns a set of objects.

ridstring

namestring

originMetadataobject

propertiesmap from strings to strings

labelsset of strings

timestampTypeenum

Allowed values: ABSOLUTERELATIVEPENDING

handleobjectOptional

descriptionstringOptional

boundsobjectOptional

POST

1 curl -X POST https://api.gov.nominal.io/api/catalog/v1/datasets-simple/multiple \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "datasetRids": [
6     "datasetRids"
7   ]
8 }'

200Successful

1 [
2   {
3     "rid": "rid",
4     "name": "name",
5     "originMetadata": {
6       "path": "path",
7       "xSeriesIsAbsolute": true,
8       "schemaDirectivePath": "schemaDirectivePath",
9       "xSeriesColumnName": "xSeriesColumnName",
10       "xSeriesTimeUnit": "DAYS",
11       "timestampMetadata": {
12         "seriesName": "seriesName",
13         "timestampType": {
14           "type": "relative",
15           "relative": {
16             "timeUnit": "DAYS",
17             "offset": "2024-01-15T09:30:00Z"
18           }
19         }
20       },
21       "channelConfig": {
22         "prefixTreeDelimiter": "prefixTreeDelimiter"
23       }
24     },
25     "properties": {
26       "properties": "properties"
27     },
28     "labels": [
29       "labels"
30     ],
31     "timestampType": "ABSOLUTE",
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   }
54 ]

Get Dataset File

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/catalog/v1/datasets-simple/multiple \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"datasetRids": [
6	"datasetRids"
7	]
8	}'

1	[
2	{
3	"rid": "rid",
4	"name": "name",
5	"originMetadata": {
6	"path": "path",
7	"xSeriesIsAbsolute": true,
8	"schemaDirectivePath": "schemaDirectivePath",
9	"xSeriesColumnName": "xSeriesColumnName",
10	"xSeriesTimeUnit": "DAYS",
11	"timestampMetadata": {
12	"seriesName": "seriesName",
13	"timestampType": {
14	"type": "relative",
15	"relative": {
16	"timeUnit": "DAYS",
17	"offset": "2024-01-15T09:30:00Z"
18	}
19	}
20	},
21	"channelConfig": {
22	"prefixTreeDelimiter": "prefixTreeDelimiter"
23	}
24	},
25	"properties": {
26	"properties": "properties"
27	},
28	"labels": [
29	"labels"
30	],
31	"timestampType": "ABSOLUTE",
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	}
54	]