List Dataset Files

GET

Path parameters

datasetRidstringRequired

Query parameters

nextPageTokenstringOptional

Response

This endpoint returns an object.

fileslist of objects

nextPagestringOptional

GET

1 curl https://api.gov.nominal.io/api/catalog/v1/datasets/datasetRid/files \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "files": [
3     {
4       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5       "datasetRid": "datasetRid",
6       "name": "name",
7       "handle": {
8         "type": "s3",
9         "s3": {
10           "bucket": "bucket",
11           "key": "key"
12         }
13       },
14       "uploadedAt": "2024-01-15T09:30:00Z",
15       "ingestStatus": {
16         "type": "success",
17         "success": {}
18       },
19       "bounds": {
20         "start": {
21           "seconds": 1000000,
22           "nanos": 1000000,
23           "picos": 1
24         },
25         "end": {
26           "seconds": 1000000,
27           "nanos": 1000000,
28           "picos": 1
29         },
30         "type": "ABSOLUTE"
31       },
32       "ingestedAt": "2024-01-15T09:30:00Z",
33       "timestampMetadata": {
34         "seriesName": "seriesName",
35         "timestampType": {
36           "type": "relative",
37           "relative": {
38             "timeUnit": "DAYS",
39             "offset": "2024-01-15T09:30:00Z"
40           }
41         }
42       }
43     },
44     {
45       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
46       "datasetRid": "datasetRid",
47       "name": "name",
48       "handle": {
49         "type": "s3",
50         "s3": {
51           "bucket": "bucket",
52           "key": "key"
53         }
54       },
55       "uploadedAt": "2024-01-15T09:30:00Z",
56       "ingestStatus": {
57         "type": "success",
58         "success": {}
59       },
60       "bounds": {
61         "start": {
62           "seconds": 1000000,
63           "nanos": 1000000,
64           "picos": 1
65         },
66         "end": {
67           "seconds": 1000000,
68           "nanos": 1000000,
69           "picos": 1
70         },
71         "type": "ABSOLUTE"
72       },
73       "ingestedAt": "2024-01-15T09:30:00Z",
74       "timestampMetadata": {
75         "seriesName": "seriesName",
76         "timestampType": {
77           "type": "relative",
78           "relative": {
79             "timeUnit": "DAYS",
80             "offset": "2024-01-15T09:30:00Z"
81           }
82         }
83       }
84     }
85   ],
86   "nextPage": "nextPage"
87 }

Get Dataset File Uri

Up Next

Built with

1	curl https://api.gov.nominal.io/api/catalog/v1/datasets/datasetRid/files \
2	-H "Authorization: Bearer <token>"

1	{
2	"files": [
3	{
4	"id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5	"datasetRid": "datasetRid",
6	"name": "name",
7	"handle": {
8	"type": "s3",
9	"s3": {
10	"bucket": "bucket",
11	"key": "key"
12	}
13	},
14	"uploadedAt": "2024-01-15T09:30:00Z",
15	"ingestStatus": {
16	"type": "success",
17	"success": {}
18	},
19	"bounds": {
20	"start": {
21	"seconds": 1000000,
22	"nanos": 1000000,
23	"picos": 1
24	},
25	"end": {
26	"seconds": 1000000,
27	"nanos": 1000000,
28	"picos": 1
29	},
30	"type": "ABSOLUTE"
31	},
32	"ingestedAt": "2024-01-15T09:30:00Z",
33	"timestampMetadata": {
34	"seriesName": "seriesName",
35	"timestampType": {
36	"type": "relative",
37	"relative": {
38	"timeUnit": "DAYS",
39	"offset": "2024-01-15T09:30:00Z"
40	}
41	}
42	}
43	},
44	{
45	"id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
46	"datasetRid": "datasetRid",
47	"name": "name",
48	"handle": {
49	"type": "s3",
50	"s3": {
51	"bucket": "bucket",
52	"key": "key"
53	}
54	},
55	"uploadedAt": "2024-01-15T09:30:00Z",
56	"ingestStatus": {
57	"type": "success",
58	"success": {}
59	},
60	"bounds": {
61	"start": {
62	"seconds": 1000000,
63	"nanos": 1000000,
64	"picos": 1
65	},
66	"end": {
67	"seconds": 1000000,
68	"nanos": 1000000,
69	"picos": 1
70	},
71	"type": "ABSOLUTE"
72	},
73	"ingestedAt": "2024-01-15T09:30:00Z",
74	"timestampMetadata": {
75	"seriesName": "seriesName",
76	"timestampType": {
77	"type": "relative",
78	"relative": {
79	"timeUnit": "DAYS",
80	"offset": "2024-01-15T09:30:00Z"
81	}
82	}
83	}
84	}
85	],
86	"nextPage": "nextPage"
87	}