Add File To Dataset

POST

Adds a single file to an existing dataset.

Path parameters

datasetRidstringRequired

Request

This endpoint expects an object.

handleobjectRequired

timestampMetadataobjectOptional

Response

This endpoint returns an object.

idUUID

datasetRidstring

Unique resource identifier for a Dataset

namestring

handleobject

uploadedAtdatetime

Timestamp that the file was received and stored, but not processed or made available to consumers.

ingestStatusobject

boundsobjectOptional

ingestedAtdatetimeOptional

Timestamp that the file is ingested at and made available for processing. If the file has failed to be ingested for any reason or is still being processed, then this value will be empty.

timestampMetadataobjectOptional

POST

1 curl -X POST https://api.gov.nominal.io/api/catalog/v1/datasets/datasetRid/add-file \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "handle": {
6     "type": "s3",
7     "s3": {
8       "bucket": "bucket",
9       "key": "key"
10     }
11   }
12 }'

200Successful

1 {
2   "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3   "datasetRid": "datasetRid",
4   "name": "name",
5   "handle": {
6     "type": "s3",
7     "s3": {
8       "bucket": "bucket",
9       "key": "key"
10     }
11   },
12   "uploadedAt": "2024-01-15T09:30:00Z",
13   "ingestStatus": {
14     "type": "success",
15     "success": {}
16   },
17   "bounds": {
18     "start": {
19       "seconds": 1000000,
20       "nanos": 1000000,
21       "picos": 1
22     },
23     "end": {
24       "seconds": 1000000,
25       "nanos": 1000000,
26       "picos": 1
27     },
28     "type": "ABSOLUTE"
29   },
30   "ingestedAt": "2024-01-15T09:30:00Z",
31   "timestampMetadata": {
32     "seriesName": "seriesName",
33     "timestampType": {
34       "type": "relative",
35       "relative": {
36         "timeUnit": "DAYS",
37         "offset": "2024-01-15T09:30:00Z"
38       }
39     }
40   }
41 }

List Dataset Files

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/catalog/v1/datasets/datasetRid/add-file \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"handle": {
6	"type": "s3",
7	"s3": {
8	"bucket": "bucket",
9	"key": "key"
10	}
11	}
12	}'

1	{
2	"id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3	"datasetRid": "datasetRid",
4	"name": "name",
5	"handle": {
6	"type": "s3",
7	"s3": {
8	"bucket": "bucket",
9	"key": "key"
10	}
11	},
12	"uploadedAt": "2024-01-15T09:30:00Z",
13	"ingestStatus": {
14	"type": "success",
15	"success": {}
16	},
17	"bounds": {
18	"start": {
19	"seconds": 1000000,
20	"nanos": 1000000,
21	"picos": 1
22	},
23	"end": {
24	"seconds": 1000000,
25	"nanos": 1000000,
26	"picos": 1
27	},
28	"type": "ABSOLUTE"
29	},
30	"ingestedAt": "2024-01-15T09:30:00Z",
31	"timestampMetadata": {
32	"seriesName": "seriesName",
33	"timestampType": {
34	"type": "relative",
35	"relative": {
36	"timeUnit": "DAYS",
37	"offset": "2024-01-15T09:30:00Z"
38	}
39	}
40	}
41	}