Get Logical Series

Get a logical series by logical series rid.

Path parameters

ridstringRequired

Response

This endpoint returns an object.

ridstring

dataSourceRidstring

Unique resource identifier for a DataSource. Typically, this is used to refer to the datasource for which a channel is associated, almost always in reference to either a dataset or a connection.

locatorobject

channelstring

timeLocatorobjectOptional

Only required to be present for legacy CSVs.

descriptionstringOptional

unitstringOptional

seriesDataTypeenumOptional

Allowed values:

granularityenumOptional

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

Allowed values:

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	"timeLocator": {
14	"type": "csvLocator",
15	"csvLocator": {
16	"s3Path": "s3Path",
17	"index": 1,
18	"usesLegacyFormat": true
19	}
20	},
21	"description": "description",
22	"unit": "unit",
23	"seriesDataType": "DOUBLE",
24	"granularity": "PICOSECONDS"
25	}

1	curl https://api.gov.nominal.io/api/timeseries/logical-series/v1/logical-series/rid \
2	-H "Authorization: Bearer <token>"

Path parameters

Headers

Response