Create Logical Series

POST

Create a new logical series.

Request

This endpoint expects an object.

channelstringRequired

locatorobjectRequired

dataSourceRidstringRequired

idLocatorUUIDOptional

If present, will be used as the locator of the LogicalSeriesRid. If a logical series already exists with this id, will throw a CONFLICT.

descriptionstringOptional

unitstringOptional

seriesDataTypeenumOptional

Allowed values: DOUBLESTRING

granularityenumOptional

Allowed values: PICOSECONDSNANOSECONDS

Response

This endpoint returns an object.

ridstring

dataSourceRidstring

locatorobject

channelstring

granularityenum

Allowed values: PICOSECONDSNANOSECONDS

Time granularity of the series. If omitted, defaults to nanoseconds.

timeLocatorobjectOptional

Only required to be present for legacy CSVs.

descriptionstringOptional

unitstringOptional

seriesDataTypeenumOptional

Allowed values: DOUBLESTRING

POST

1 curl -X POST https://api.gov.nominal.io/api/timeseries/logical-series/v1/logical-series \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "channel": "channel",
6   "locator": {
7     "type": "csvLocator",
8     "csvLocator": {
9       "s3Path": "s3Path",
10       "index": 1
11     }
12   },
13   "dataSourceRid": "dataSourceRid"
14 }'

200Successful

1 {
2   "rid": "rid",
3   "dataSourceRid": "dataSourceRid",
4   "locator": {
5     "type": "csvLocator",
6     "csvLocator": {
7       "s3Path": "s3Path",
8       "index": 1,
9       "usesLegacyFormat": true
10     }
11   },
12   "channel": "channel",
13   "granularity": "PICOSECONDS",
14   "timeLocator": {
15     "type": "csvLocator",
16     "csvLocator": {
17       "s3Path": "s3Path",
18       "index": 1,
19       "usesLegacyFormat": true
20     }
21   },
22   "description": "description",
23   "unit": "unit",
24   "seriesDataType": "DOUBLE"
25 }

Batch Create Logical Series

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/timeseries/logical-series/v1/logical-series \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"channel": "channel",
6	"locator": {
7	"type": "csvLocator",
8	"csvLocator": {
9	"s3Path": "s3Path",
10	"index": 1
11	}
12	},
13	"dataSourceRid": "dataSourceRid"
14	}'

1	{
2	"rid": "rid",
3	"dataSourceRid": "dataSourceRid",
4	"locator": {
5	"type": "csvLocator",
6	"csvLocator": {
7	"s3Path": "s3Path",
8	"index": 1,
9	"usesLegacyFormat": true
10	}
11	},
12	"channel": "channel",
13	"granularity": "PICOSECONDS",
14	"timeLocator": {
15	"type": "csvLocator",
16	"csvLocator": {
17	"s3Path": "s3Path",
18	"index": 1,
19	"usesLegacyFormat": true
20	}
21	},
22	"description": "description",
23	"unit": "unit",
24	"seriesDataType": "DOUBLE"
25	}