Update Dataset Metadata

PUT

Path parameters

datasetRidstringRequired

Request

This endpoint expects an object.

namestringOptional

descriptionstringOptional

labelsset of stringsOptional

propertiesmap from strings to stringsOptional

Response

This endpoint returns an object.

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

PUT

1 curl -X PUT https://api.gov.nominal.io/api/catalog/v1/datasets/datasetRid \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

200Updated

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

Update Bounds

Up Next

Built with

1	curl -X PUT https://api.gov.nominal.io/api/catalog/v1/datasets/datasetRid \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

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