Get Enriched Datasets

POST

Request

This endpoint expects an object.

datasetRidsset of stringsRequired

Response

This endpoint returns a set of objects.

ridstring

uuidUUID

namestring

displayNamestring

ingestDatedatetime

originMetadataobject

lastIngestStatusobject

retentionPolicyobject

timestampTypeenum

Allowed values: ABSOLUTERELATIVEPENDING

labelsset of strings

propertiesmap from strings to strings

granularity"PICOSECONDS" or "NANOSECONDS"

Allowed values: PICOSECONDSNANOSECONDS

descriptionstringOptional

metadatamap from strings to stringsOptional

handleobjectOptional

ingestStatusenumOptional

Allowed values: IN_PROGRESSCOMPLETEDFAILED

sourcestringOptional

boundsobjectOptional

POST

1 curl -X POST https://api.gov.nominal.io/api/catalog/v1/datasets/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     "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5     "name": "name",
6     "displayName": "displayName",
7     "ingestDate": "2024-01-15T09:30:00Z",
8     "originMetadata": {
9       "path": "path",
10       "xSeriesIsAbsolute": true,
11       "schemaDirectivePath": "schemaDirectivePath",
12       "xSeriesColumnName": "xSeriesColumnName",
13       "xSeriesTimeUnit": "DAYS",
14       "timestampMetadata": {
15         "seriesName": "seriesName",
16         "timestampType": {
17           "type": "relative",
18           "relative": {
19             "timeUnit": "DAYS",
20             "offset": "2024-01-15T09:30:00Z"
21           }
22         }
23       },
24       "channelConfig": {
25         "prefixTreeDelimiter": "prefixTreeDelimiter"
26       }
27     },
28     "lastIngestStatus": {
29       "type": "success",
30       "success": {}
31     },
32     "retentionPolicy": {
33       "type": "KEEP_UNTIL_EXPIRY",
34       "expiryDays": 1
35     },
36     "timestampType": "ABSOLUTE",
37     "labels": [
38       "labels"
39     ],
40     "properties": {
41       "properties": "properties"
42     },
43     "granularity": "PICOSECONDS",
44     "description": "description",
45     "metadata": {
46       "metadata": "metadata"
47     },
48     "handle": {
49       "type": "s3",
50       "s3": {
51         "bucket": "bucket",
52         "key": "key"
53       }
54     },
55     "ingestStatus": "IN_PROGRESS",
56     "source": "source",
57     "bounds": {
58       "start": {
59         "seconds": 1000000,
60         "nanos": 1000000,
61         "picos": 1
62       },
63       "end": {
64         "seconds": 1000000,
65         "nanos": 1000000,
66         "picos": 1
67       },
68       "type": "ABSOLUTE"
69     }
70   }
71 ]

Get Dataset

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/catalog/v1/datasets/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	"uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5	"name": "name",
6	"displayName": "displayName",
7	"ingestDate": "2024-01-15T09:30:00Z",
8	"originMetadata": {
9	"path": "path",
10	"xSeriesIsAbsolute": true,
11	"schemaDirectivePath": "schemaDirectivePath",
12	"xSeriesColumnName": "xSeriesColumnName",
13	"xSeriesTimeUnit": "DAYS",
14	"timestampMetadata": {
15	"seriesName": "seriesName",
16	"timestampType": {
17	"type": "relative",
18	"relative": {
19	"timeUnit": "DAYS",
20	"offset": "2024-01-15T09:30:00Z"
21	}
22	}
23	},
24	"channelConfig": {
25	"prefixTreeDelimiter": "prefixTreeDelimiter"
26	}
27	},
28	"lastIngestStatus": {
29	"type": "success",
30	"success": {}
31	},
32	"retentionPolicy": {
33	"type": "KEEP_UNTIL_EXPIRY",
34	"expiryDays": 1
35	},
36	"timestampType": "ABSOLUTE",
37	"labels": [
38	"labels"
39	],
40	"properties": {
41	"properties": "properties"
42	},
43	"granularity": "PICOSECONDS",
44	"description": "description",
45	"metadata": {
46	"metadata": "metadata"
47	},
48	"handle": {
49	"type": "s3",
50	"s3": {
51	"bucket": "bucket",
52	"key": "key"
53	}
54	},
55	"ingestStatus": "IN_PROGRESS",
56	"source": "source",
57	"bounds": {
58	"start": {
59	"seconds": 1000000,
60	"nanos": 1000000,
61	"picos": 1
62	},
63	"end": {
64	"seconds": 1000000,
65	"nanos": 1000000,
66	"picos": 1
67	},
68	"type": "ABSOLUTE"
69	}
70	}
71	]