Gets a time series by name
GET /repositories/{repository}/timeSeries/{timeSeries}
Get a specific time series by using its name
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
repository |
path | string |
yes | The repository in which the time series is stored. |
timeSeries |
path | string |
yes | The name or id (prefixed with ‘id:’) of the time series to load |
include |
query | string[] |
no | Related data to load together with each time series. May be repeated ( ?include=attributes&include=attributeUnits) or comma separated (?include=attributes,attributeUnits).- attributes - the attributes assigned to the time series and their values.- attributeUnits - the list attribute unit of each assignment, including its name. Implies attributes.- listAttributeValues - the list attribute values the data of each list attribute assignment uses, as a usedValues object keyed by the raw value (verbatim, whatever the casing) whose values have the shape of GET /repositories/{repository}/lists/units/{unit}/values, or are null when the effective unit (the unit of the assignment, else the only unit of its attribute, else the default unit of an attribute with several units) does not list the value or there is none. Implies attributes, but not attributeUnits. Enum: attributes, attributeUnits, listAttributeValues |
Responses
Section titled “Responses”| Code | Description | Type |
|---|---|---|
200 |
The time series has been found. | ResolvedTimeSeriesReferenceOfInt32 |
404 |
Indicates that the given time series was not found within the given repository or that the given repository itself does not exist. | ProblemDetails |
4XX |
Indicates that the request failed due to a client error. Please refer to the details provided in the body of the response in order to ensure that the request can be handled properly. | ProblemDetails |
5XX |
Indicates that the request failed due to an error that occurred on the server. Consider reporting this error to the server operators. | ProblemDetails |
Schema: ResolvedTimeSeriesReferenceOfInt32
{ "storageInformation": { "repositoryName": "string" }, "identifier": 0, "value": { "name": "string", "description": "string", "function": 2, "cyclic": true, "interval": { "type": 2, "multiplier": 0 }, "unit": { "storageInformation": { "repositoryName": "string" }, "identifier": "string" }, "intervalTransformationMethod": 1, "formula": { "2020-01-01T00:00:00Z": "Its a formula!" }, "timeZone": "Europe/Vienna", "startOfTime": "2026-01-01T00:00:00Z", "preserveDuplicatedValues": true, "preserveHistoricData": true, "preserveAuditLog": true, "quotation": true, "quotationDefaultBehavior": 2, "compressionMode": 1, "compressionMultiplier": 0 }}Schema: ResolvedTimeSeriesReferenceOfInt32
{ "storageInformation": { "repositoryName": "string" }, "identifier": 0, "value": { "name": "string", "description": "string", "function": 2, "cyclic": true, "interval": { "type": 2, "multiplier": 0 }, "unit": { "storageInformation": { "repositoryName": "string" }, "identifier": "string" }, "intervalTransformationMethod": 1, "formula": { "2020-01-01T00:00:00Z": "Its a formula!" }, "timeZone": "Europe/Vienna", "startOfTime": "2026-01-01T00:00:00Z", "preserveDuplicatedValues": true, "preserveHistoricData": true, "preserveAuditLog": true, "quotation": true, "quotationDefaultBehavior": 2, "compressionMode": 1, "compressionMultiplier": 0 }}Schema: ProblemDetails
{ "type": "?", "title": "HK09008", "status": 400, "detail": "A description of the problem", "instance": "https://..", "root": { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." }, "roots": [ { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." }, { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." } ], "traceId": "dd71e2e0-c77a-4608-b1d7-fcb9353b9a35"}Schema: ProblemDetails
{ "type": "?", "title": "HK09008", "status": 400, "detail": "A description of the problem", "instance": "https://..", "root": { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." }, "roots": [ { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." }, { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." } ], "traceId": "dd71e2e0-c77a-4608-b1d7-fcb9353b9a35"}Schema: ProblemDetails
{ "type": "?", "title": "HK09008", "status": 400, "detail": "A description of the problem", "instance": "https://..", "root": { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." }, "roots": [ { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." }, { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." } ], "traceId": "dd71e2e0-c77a-4608-b1d7-fcb9353b9a35"}Schema: ProblemDetails
{ "type": "?", "title": "HK09008", "status": 400, "detail": "A description of the problem", "instance": "https://..", "root": { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." }, "roots": [ { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." }, { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." } ], "traceId": "dd71e2e0-c77a-4608-b1d7-fcb9353b9a35"}Schema: ProblemDetails
{ "type": "?", "title": "HK09008", "status": 400, "detail": "A description of the problem", "instance": "https://..", "root": { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." }, "roots": [ { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." }, { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." } ], "traceId": "dd71e2e0-c77a-4608-b1d7-fcb9353b9a35"}Schema: ProblemDetails
{ "type": "?", "title": "HK09008", "status": 400, "detail": "A description of the problem", "instance": "https://..", "root": { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." }, "roots": [ { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." }, { "type": "?", "title": "HK15019", "status": 500, "detail": "An error occurred while performing the requested operation...", "instance": "https://.." } ], "traceId": "dd71e2e0-c77a-4608-b1d7-fcb9353b9a35"}Was this page helpful?Thanks for your feedback!