Update Dataset Metadata

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 "allowStreaming": true, 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 }

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:

labelsset of strings

propertiesmap from strings to strings

granularityenum

Allowed values:

allowStreamingboolean

descriptionstringOptional

metadatamap from strings to stringsOptional

handleobjectOptional

ingestStatusenumOptional

Allowed values:

sourcestringOptional

boundsobjectOptional

Path parameters

Headers

Request

Response