Based on REST principles, the TrendMiner Data Sources API endpoints provide access to data source configuration and operations related to synchronization and requesting data from sources.

1. Authentication

All requests to the web API require authentication. This is achieved by sending a valid Bearer access token in the request headers. Request tokens are obtained using OAuth2.0.

Requests to the API can be done authenticated as your client or authenticated as a specific user. In both cases, you will first need to create a client and request a token.

When performing actions authenticated as a client, they will belong to service-account-CLIENTID.

Make sure you are calling our services over HTTPS when retrieving an access token.

1.1. Creating a new client

A new client can be created in ConfigHub: Security → Clients → Add client

1.2. Retrieving an access token

1.2.1. For your client

To retrieve a token to authenticate as your client, you will need:

  • Your client ID

  • Your client secret (can be obtained in ConfigHub)

A token is requested from the token endpoint of the authentication service:

Request
curl --request POST \
  --url 'https://YOUR_DOMAIN/auth/realms/trendminer/protocol/openid-connect/token' \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data grant_type=client_credentials \
  --data client_id=YOUR_CLIENT_ID \
  --data client_secret=YOUR_CLIENT_SECRET

Upon valid authentication, the response will contain an access token.

Response
200 OK
{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJwcXZ1UXB...", (1)
  "expires_in": 300,
  "refresh_expires_in": 0,
  "token_type": "Bearer",
  "not-before-policy": 1571391000,
  "scope": "email profile"
}

  1. The access token is to be used in every request towards our services (see example below). A new token needs to be fetched when the token expires after 5 minutes.

1.2.2. For a specific user

To retrieve a token to authenticate as a specific user, you will need:

  • Your client ID

  • Your client secret (can be obtained in ConfigHub)

  • The user’s username

  • The user’s password

A token is requested from the token endpoint of the authentication service.

Request
curl --request POST \
--url 'https://YOUR_DOMAIN/auth/realms/trendminer/protocol/openid-connect/token' \
--header 'content-type: application/x-www-form-urlencoded' \
--data grant_type=password \
--data client_id=YOUR_CLIENT_ID \
--data client_secret=YOUR_CLIENT_SECRET \
--data username=USERNAME \
--data password=PASSWORD
Response
200 OK
{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJwcXZ1UXB...", (1)
  "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI0M2U1YR...", (2)
  "expires_in": 300,
  "refresh_expires_in": 1800,
  "token_type": "Bearer",
  "not-before-policy": 1571391000,
  "scope": "email profile"
}

  1. The access token is to be used in every request towards our services (see example below). A new token needs to be fetched when the token expires after 5 minutes.

  2. The refresh token can be used to retrieve a new access token for the same session

Using the refresh token

The refresh token can be used to retrieve a new access token for the same session:

Request
curl --request POST \
--url 'https://YOUR_DOMAIN/auth/realms/trendminer/protocol/openid-connect/token' \
--header 'content-type: application/x-www-form-urlencoded' \
--data grant_type=refresh_token \
--data client_id=YOUR_CLIENT_ID \
--data client_secret=YOUR_CLIENT_SECRET \
--data refresh_token=REFRESH_TOKEN
=== Doing a request with an access token
Example request with access token
curl --request GET \
  --url 'https://YOUR_DOMAIN/ds/[any api]' \
  --header 'Authorization: Bearer ACCESS_TOKEN'

2. Resources

2.1. Asset

2.1.1. Get a specific asset denoted by the provided assetId

GET /datasources/{id}/assets/{assetId}

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID

Path required

assetId

The identifier of the asset

String
Responses

HTTP Code

Description

Schema

404

The resource was not found

AssetRepresentation

200

Ok

AssetRepresentation

501

Datasource does not support 'ASSET' capability

AssetRepresentation
Produces

  • application/json

2.1.2. Get assets by ids from the tree

POST /datasources/{id}/assets

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID

Body

required

string

[string]
Responses

HTTP Code

Description

Schema

404

The resource was not found

List[AssetRepresentation]

200

Ok

List[AssetRepresentation]

501

Datasource does not support 'ASSET' capability

List[AssetRepresentation]
Produces

  • application/json

2.1.3. Get all root assets from the tree

GET /datasources/{id}/assets

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID
Responses

HTTP Code

Description

Schema

404

The resource was not found

List[AssetRepresentation]

200

Ok

List[AssetRepresentation]
Produces

  • application/json

2.2. Configuration

2.2.1. Get the full list of configuration items

GET /configurations

Parameters

Type

Name

Description

Schema

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property(,asc

desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses

HTTP Code

Description

Schema

200

Ok

PagedModelConfigurationItemRepresentation
Produces

  • application/json

  • application/hal+json

2.2.2. Get a configuration item by name

GET /configurations/{name}

Parameters

Type

Name

Description

Schema

Path required

name

Name of the configuration item to return

String
Responses

HTTP Code

Description

Schema

200

Ok

ConfigurationItemRepresentation
Produces

  • application/json

2.2.3. Update a configuration item.

PUT /configurations/{name}

Parameters

Type

Name

Description

Schema

Path required

name

Name of the configuration item to update

String

Query

required

value

New value to update
Responses

HTTP Code

Description

Schema

404

The configuration item was not found

ConfigurationItemRepresentation

200

Successfully updated configuration item

ConfigurationItemRepresentation
Produces

  • /

2.3. Connectors

2.3.1. Create a new connector.

POST /connectors

Parameters

Type

Name

Description

Schema

Body

required

ConnectorModel

ConnectorModel
Responses

HTTP Code

Description

Schema

400

Bad Request

ConnectorRepresentation

201

Created

ConnectorRepresentation
Produces

  • application/json

2.3.2. Delete a connector.

DELETE /connectors/{id}

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the connector

UUID
Responses

HTTP Code

Description

Schema

404

The resource was not found

204

No content

2.3.3. Get a list of all connectors

GET /connectors

Parameters

Type

Name

Description

Schema

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property(,asc

desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses

HTTP Code

Description

Schema

200

Ok

PagedModelConnectorRepresentation
Produces

  • application/json

  • application/hal+json

2.3.4. Get the connector for the specified identifier.

GET /connectors/{id}

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the connector

UUID
Responses

HTTP Code

Description

Schema

404

The resource was not found

ConnectorRepresentation

200

Ok

ConnectorRepresentation
Produces

  • application/json

2.3.5. Get the version of a connector.

GET /connectors/{id}/version

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the connector

UUID
Responses

HTTP Code

Description

Schema

404

The resource was not found

VersionInfo

200

Ok

VersionInfo
Produces

  • /

2.3.6. Get a list of all datasources which belong to a connector

GET /connectors/datasources

Parameters

Type

Name

Description

Schema

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property(,asc

desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses

HTTP Code

Description

Schema

200

Ok

PagedModelDatasourceRepresentation
Produces

  • application/json

  • application/hal+json

2.3.7. Synchronizes a connector.

POST /connectors/{id}/sync

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the connector

UUID
Responses

HTTP Code

Description

Schema

404

The resource was not found

200

Ok

2.3.8. Test connector connection.

POST /connectors/{id}/test

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the connector

UUID
Responses

HTTP Code

Description

Schema

404

The resource was not found

ConnectionTest

200

Ok

ConnectionTest
Produces

  • /

2.3.9. Update a connector.

PUT /connectors/{id}

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the connector

UUID

Body

required

ConnectorModel

ConnectorModel
Responses

HTTP Code

Description

Schema

400

Bad Request

ConnectorRepresentation

404

The resource was not found

ConnectorRepresentation

200

Ok

ConnectorRepresentation
Produces

  • application/json

2.4. Context

2.4.1. Returns a list of changed context items in the source system as well as the type of change that happened.

GET /datasources/{id}/context/changes

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID

Query

required

since

The start date of the query period. Internet DateTime format, see RFC3339 e.g.: '2012-01-01T00:00:00Z’.

Query

optional

page

The page to get. This is a cookie that is returned by a previous call to the /changes endpoint.

Query

optional

size

The page size
Responses

HTTP Code

Description

Schema

404

The resource was not found

CursorPagedResourcesContextChange

501

Datasource does not support 'CONTEXT' capability

CursorPagedResourcesContextChange

200

Ok

CursorPagedResourcesContextChange
Produces

  • application/json

  • application/hal+json

2.4.2. Get a list of available context fields for the given datasource

GET /datasources/{id}/context/field

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property(,asc

desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses

HTTP Code

Description

Schema

404

The resource was not found

PagedModelFieldRepresentation

501

Datasource does not support 'CONTEXT' capability

PagedModelFieldRepresentation

200

Ok

PagedModelFieldRepresentation
Produces

  • application/json

  • application/hal+json

2.4.3. Get a context item for the given datasource and context id.

GET /datasources/{id}/context/{contextItemId}

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID

Path required

contextItemId

The identifier of the contextItem

String
Responses

HTTP Code

Description

Schema

404

The resource was not found

ContextItemRepresentation

501

Datasource does not support 'CONTEXT' capability

ContextItemRepresentation

200

Ok

ContextItemRepresentation
Produces

  • application/json

  • application/hal+json

2.4.4. Get a list of context items for the given datasource

GET /datasources/{id}/context

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID

Query

required

startDate

The start date of the query period. Internet DateTime format, see RFC3339 e.g.: '2012-01-01T00:00:00Z’.

Query

required

endDate

The end date of the query period. Internet DateTime format, see RFC3339 e.g.: '2012-01-01T00:00:00Z’.

Query

optional

createdAfter

Returned context items need to be created after this date. Internet DateTime format, see RFC3339 e.g.: '2012-01-01T00:00:00Z’.

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property(,asc

desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses

HTTP Code

Description

Schema

404

The resource was not found

PagedModelContextItemRepresentation

501

Datasource does not support 'CONTEXT' capability

PagedModelContextItemRepresentation

200

Ok

PagedModelContextItemRepresentation
Produces

  • application/json

  • application/hal+json

2.4.5. Get a list of context items for the given datasource and context identifiers.

POST /datasources/{id}/context

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID

Body

required

string

[string]
Responses

HTTP Code

Description

Schema

404

The resource was not found

List[ContextItemRepresentation]

501

Datasource does not support 'CONTEXT' capability

List[ContextItemRepresentation]

200

Ok

List[ContextItemRepresentation]
Produces

  • application/json

  • application/hal+json

2.4.6. Get a list of available context types for the given datasource

GET /datasources/{id}/context/type

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property(,asc

desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses

HTTP Code

Description

Schema

404

The resource was not found

PagedModelContextTypeRepresentation

501

Datasource does not support 'CONTEXT' capability

PagedModelContextTypeRepresentation

200

Ok

PagedModelContextTypeRepresentation
Produces

  • application/json

  • application/hal+json

2.4.7. Get a list of available context workflows for the given datasource

GET /datasources/{id}/context/workflow

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property(,asc

desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses

HTTP Code

Description

Schema

404

The resource was not found

PagedModelWorkflowRepresentation

501

Datasource does not support 'CONTEXT' capability

PagedModelWorkflowRepresentation

200

Ok

PagedModelWorkflowRepresentation
Produces

  • application/json

  • application/hal+json

2.5. Datasources

2.5.1. Create a new datasource.

POST /datasources

Parameters

Type

Name

Description

Schema

Body

required

DatasourceModel

DatasourceModel
Responses

HTTP Code

Description

Schema

400

Bad Request

DatasourceRepresentation

404

The resource was not found

DatasourceRepresentation

201

Created

DatasourceRepresentation
Produces

  • application/json

2.5.2. Delete a datasource.

DELETE /datasources/{id}

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID
Responses

HTTP Code

Description

Schema

404

The resource was not found

204

No content

2.5.3. Get the datasource for the specified identifier.

GET /datasources/{id}

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID
Responses

HTTP Code

Description

Schema

404

The resource was not found

DatasourceRepresentation

200

Ok

DatasourceRepresentation
Produces

  • application/json

2.5.4. Get a list of all datasources

GET /datasources

Parameters

Type

Name

Description

Schema

Query

optional

type

The datasource type

Query

optional

capabilityType

The capability type

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property(,asc

desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses

HTTP Code

Description

Schema

200

Ok

PagedModelDatasourceRepresentation
Produces

  • application/json

  • application/hal+json

2.5.5. Synchronizes datasource time series definitions.

POST /datasources/{id}/sync

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID
Responses

HTTP Code

Description

Schema

404

The resource was not found

200

Ok

2.5.6. Test datasource time series definitions.

POST /datasources/{id}/test

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID
Responses

HTTP Code

Description

Schema

404

The resource was not found

ConnectionStatus

200

Ok

ConnectionStatus
Produces

  • /

2.5.7. Update a datasource.

PUT /datasources/{id}

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID

Body

required

DatasourceModel

DatasourceModel
Responses

HTTP Code

Description

Schema

400

Bad Request

DatasourceRepresentation

404

The resource was not found

DatasourceRepresentation

200

Ok

DatasourceRepresentation
Produces

  • application/json

2.6. ImportedTimeSeries

2.6.1. Delete an imported time series.

DELETE /imported/timeseries/{id}

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the imported time series

UUID
Responses

HTTP Code

Description

Schema

404

The resource was not found

204

No content

2.6.2. Delete all imported time series.

DELETE /imported/timeseries/

Parameters
Type Name Description Schema
Responses

HTTP Code

Description

Schema

404

The resource was not found

204

No content

2.6.3. Get the imported time series by specified id.

GET /imported/timeseries/{id}

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the imported time series

UUID
Responses

HTTP Code

Description

Schema

404

The resource was not found

ImportedTimeSeriesRepresentation

200

Ok

ImportedTimeSeriesRepresentation
Produces

  • application/json

2.6.4. Search the imported time series.

GET /imported/timeseries

Parameters

Type

Name

Description

Schema

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property(,asc

desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses

HTTP Code

Description

Schema

200

Ok

PagedModelImportedTimeSeriesRepresentation
Produces

  • application/json

2.6.5. Imports time series from a csv file

POST /imported/timeseries

Parameters
Type Name Description Schema
Responses

HTTP Code

Description

Schema

204

Valid

List[NotImportedTimeSeries]

400

Bad Request

List[NotImportedTimeSeries]

422

Validation error

List[NotImportedTimeSeries]
Produces

  • /

2.7. LegacyTimeSeries

2.7.1. Get the timeseries definition for the specified id

GET /legacy-timeseries/{id}

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the timeseries definition

UUID

Query

optional

fetchStates

Should fetch states
Responses

HTTP Code

Description

Schema

404

The resource was not found

LegacyTagDetailsModel

200

Ok

LegacyTagDetailsModel
Produces

  • /

2.7.2. Get timeseries definition accessibility details.

GET /legacy-timeseries/accessibility

Parameters

Type

Name

Description

Schema

Query

required

tagName

The name of the timeseries definition
Responses

HTTP Code

Description

Schema

404

The resource was not found

LegacyAccessibilityModel

200

Ok

LegacyAccessibilityModel
Produces

  • application/json

2.7.3. Get the timeseries definition by name query parameter.

GET /legacy-timeseries

Parameters

Type

Name

Description

Schema

Query

required

tagName

The name of the timeseries definition

Query

optional

fetchStates

Should fetch states
Responses

HTTP Code

Description

Schema

404

The resource was not found

LegacyTagDetailsModel

200

Ok

LegacyTagDetailsModel
Produces

  • application/json

2.7.4. Get all states of the timeseries definition by id query parameter.

GET /legacy-timeseries/{id}/states

Parameters

Type

Name

Description

Schema

Path required

id

The id of the timeseries definition

String
Responses

HTTP Code

Description

Schema

404

The resource was not found

List[LegacyStateModel]

200

Ok

List[LegacyStateModel]
Produces

  • /

2.8. Providers

2.8.1. Get a list of all providers and their metadata

GET /providers

Parameters
Type Name Description Schema
Responses

HTTP Code

Description

Schema

200

Ok

List[ProviderMetaDataRepresentation]
Produces

  • application/json

  • application/hal+json

2.8.2. Get a provider and its metadata

GET /providers/{name}

Parameters

Type

Name

Description

Schema

Path required

name

String
Responses

HTTP Code

Description

Schema

200

Ok

ProviderMetaDataRepresentation
Produces

  • application/json

  • application/hal+json

2.9. TimeSeries

2.9.1. EXPERIMENTAL - basic search

POST /timeseries/basicsearch

Parameters

Type

Name

Description

Schema

Body

required

BasicSearchRequest

BasicSearchRequest
Responses

HTTP Code

Description

Schema

200

OK

CollectionModelTimeSeriesDefinitionRepresentation
Produces

  • application/json

  • application/hal+json

2.9.2. EXPERIMENTAL - advanced search

POST /timeseries/advancedsearch

Parameters

Type

Name

Description

Schema

Body

required

AdvancedSearchRequest

AdvancedSearchRequest
Responses

HTTP Code

Description

Schema

200

OK

CollectionModelTimeSeriesDefinitionRepresentation
Produces

  • application/json

  • application/hal+json

2.9.3. Search the time series definition by name and description patterns

GET /timeseries/advanced

Parameters

Type

Name

Description

Schema

Query

optional

nameSearchPattern

Pattern to search time series definitions by name.

Query

optional

descriptionSearchPattern

Pattern to search time series definitions by description.

Query

optional

historians

Pattern to search time series definitions by description

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property(,asc

desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses

HTTP Code

Description

Schema

200

Ok

PagedModelTimeSeriesDefinitionRepresentation
Produces

  • application/json

  • application/hal+json

2.9.4. Check whether the logged in user is allowed to read the time series.

GET /timeseries/{id}/accessibility

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the time series definition

UUID
Responses

HTTP Code

Description

Schema

200

Ok

String
Produces

  • application/json

2.9.5. Create a new time series definition.

POST /timeseries

Parameters

Type

Name

Description

Schema

Body

required

TimeSeriesDefinitionModel

TimeSeriesDefinitionModel
Responses

HTTP Code

Description

Schema

400

Bad Request

TimeSeriesDefinitionRepresentation

201

Created

TimeSeriesDefinitionRepresentation
Produces

  • application/json

2.9.6. Delete time series definitions.

DELETE /timeseries/{ids}

Parameters

Type

Name

Description

Schema

Path required

ids

The id's of the time series

UUID
Responses

HTTP Code

Description

Schema

404

The resource was not found

204

No content

2.9.7. Deletes a time series definition by datasource id and external id

DELETE /timeseries

Parameters

Type

Name

Description

Schema

Query

required

datasourceId

The identifier of the datasource

Query

required

externalId

The external identifier of the time series.
Responses

HTTP Code

Description

Schema

404

The resource was not found

204

No content

2.9.8. Get the value mapping for the specified time series, string or int value. If stringValue is present and autocreate=true - new value mapping entry will be created

GET /timeseries/{id}/valuemapping

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the time series definition

UUID

Query

optional

intValue

Int value of value mapping

Query

optional

stringValue

String value of value mapping

Query

optional

autocreate

Create new value mapping if string value is not present for requested time series definition
Responses

HTTP Code

Description

Schema

404

The resource was not found

TimeSeriesValueMappingRepresesentation

200

Ok

TimeSeriesValueMappingRepresesentation
Produces

  • application/json

2.9.9. Get the time series definition for the specified identifier.

GET /timeseries/{id}

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the time series definition

UUID
Responses

HTTP Code

Description

Schema

404

The resource was not found

TimeSeriesDefinitionRepresentation

200

Ok

TimeSeriesDefinitionRepresentation
Produces

  • application/json

2.9.10. Get the time series definition for the specified identifier with dependency tree.

GET /timeseries/{id}/dependency-tree

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the time series definition

UUID
Responses

HTTP Code

Description

Schema

404

The resource was not found

TimeSeriesDependencyTreeDefinitionRepresentation

200

Ok

TimeSeriesDependencyTreeDefinitionRepresentation
Produces

  • application/json

2.9.11. Get the time series definition by external id for the specified identifier with dependency tree.

GET /timeseries/dependency-tree

Parameters

Type

Name

Description

Schema

Query

required

datasourceId

The identifier of the datasource.

Query

required

externalId

The external identifier of the time series definition

Query

optional

deletedAllowed

Allow deleted time series definition
Responses

HTTP Code

Description

Schema

404

The resource was not found

TimeSeriesDependencyTreeDefinitionRepresentation

200

Ok

TimeSeriesDependencyTreeDefinitionRepresentation
Produces

  • application/json

2.9.12. Get the time series definitions relations.

GET /timeseries/relations

Parameters

Type

Name

Description

Schema

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property(,asc

desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses

HTTP Code

Description

Schema

200

Ok

PagedModelTimeSeriesRelationRepresentation
Produces

  • application/json

2.9.13. Get all digital states for the specified time series.

GET /timeseries/{id}/valuesmapping

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the time series definition

UUID

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property(,asc

desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses

HTTP Code

Description

Schema

404

The resource was not found

PagedModelTimeSeriesValueMappingRepresesentation

200

Ok

PagedModelTimeSeriesValueMappingRepresesentation
Produces

  • application/json

  • application/hal+json

2.9.14. Get the digital states by intValue for the specified time series.

POST /timeseries/{id}/valuesmapping

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the time series definition

UUID

Body

optional

body

The identifiers of the value mappings (as array)

[string]
Responses

HTTP Code

Description

Schema

404

The resource was not found

List[TimeSeriesValueMappingRepresesentation]

200

Ok

List[TimeSeriesValueMappingRepresesentation]
Produces

  • application/json

  • application/hal+json

2.9.15. Effective index horizon

GET /timeseries/indexhorizon

Parameters
Type Name Description Schema
Responses

HTTP Code

Description

Schema

200

OK

IndexHorizonRepresentation
Produces

  • application/json

2.9.16. Search the time series definition with rsql.

POST /timeseries/search

Parameters

Type

Name

Description

Schema

Query

optional

deletedAllowed

True if deleted time series should be returned

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property(,asc

desc). Default sort order is ascending. Multiple sort criteria are supported.

[String]

Body

required

RsqlRequest
Responses

HTTP Code

Description

Schema

200

OK

PagedModelTimeSeriesDefinitionRepresentation
Produces

  • application/json

  • application/hal+json

2.9.17. Search the time series definitions

GET /timeseries

Parameters

Type

Name

Description

Schema

Query

optional

searchPattern

Pattern to search time series definitions. Cannot be used at the same time as name parameter.

Query

optional

name

The name of the time series definitions to search for. Cannot be used at the same time as searchPattern parameter.

Query

optional

deletedAllowed

Allow deleted time series definition

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property(,asc

desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses

HTTP Code

Description

Schema

200

Ok

PagedModelTimeSeriesDefinitionRepresentation
Produces

  • application/json

  • application/hal+json

2.9.18. Search digital states for the specified time series with rsql.

POST /timeseries/{id}/valuesmapping/search

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the time series definition

UUID

Query

optional

page

Zero-based page index (0..N)

Query

optional

size

The size of the page to be returned

Query

optional

sort

Sorting criteria in the format: property(,asc

desc). Default sort order is ascending. Multiple sort criteria are supported.

[String]

Body

required

RsqlRequest
Responses

HTTP Code

Description

Schema

404

The resource was not found

PagedModelTimeSeriesValueMappingRepresesentation

200

Ok

PagedModelTimeSeriesValueMappingRepresesentation
Produces

  • application/json

  • application/hal+json

2.9.19. Update a time series definition.

PUT /timeseries/{id}

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the time series definition

UUID

Body

required

TimeSeriesDefinitionModel

TimeSeriesDefinitionModel
Responses

HTTP Code

Description

Schema

400

Bad Request

TimeSeriesDefinitionRepresentation

404

The resource was not found

TimeSeriesDefinitionRepresentation

200

Ok

TimeSeriesDefinitionRepresentation
Produces

  • application/json

2.9.20. Update a time series definition by datasource id and external id.

PUT /timeseries

Parameters

Type

Name

Description

Schema

Query

required

datasourceId

The identifier of the datasource

Query

required

externalId

The external identifier of the time series.

Body

required

TimeSeriesDefinitionModel

TimeSeriesDefinitionModel
Responses

HTTP Code

Description

Schema

400

Bad Request

TimeSeriesDefinitionRepresentation

404

The resource was not found

TimeSeriesDefinitionRepresentation

200

Ok

TimeSeriesDefinitionRepresentation
Produces

  • application/json

3. Models

3.1. AdvancedSearchRequest

Field Name Required Type Description Format

name

String

description

String

datasources

List of [UUID]

uuid

3.2. Asset

Field Name Required Type Description Format

identifier

String

parentIdentifier

String

type

String

template

Template

data

Data

name

String

description

String

3.3. AssetRepresentation

Field Name Required Type Description Format

identifier

String

parentIdentifier

String

type

String

children

List of Asset

template

Template

data

oneOf<DataReferenceData,NumericData,StringArrayData,StringData>

name

String

description

String

links

List of Link

3.4. BasicSearchRequest

Field Name Required Type Description Format

query

X

String

datasources

List of [UUID]

uuid

3.5. CapabilitiesModel

Field Name Required Type Description Format

canChangeInterpolationType

Boolean

3.6. CapabilityProperty

Field Name Required Type Description Format

name

String

label

String

placeholder

String

type

String

Enum: SINGLE_LINE, MULTI_LINE, BOOL, DROPDOWN,

capabilities

List of [string]

Enum:

options

List of DropDownOption

required

Boolean

encrypted

Boolean

3.7. CollectionModelTimeSeriesDefinitionRepresentation

Field Name Required Type Description Format

links

List of Link

content

List of TimeSeriesDefinitionRepresentation

3.8. Component

Field Name Required Type Description Format

identifier

String

type

String

3.9. ComponentModel

Field Name Required Type Description Format

identifier

String

type

String

3.10. ConfigurationItemRepresentation

Field Name Required Type Description Format

name

String

value

String

description

String

createdBy

String

createOn

Date

date-time

modifiedBy

String

modifiedOn

Date

date-time

links

List of Link

3.11. ConnectionStatus

Field Name Required Type Description Format

healthy

Boolean

3.12. ConnectionTest

Field Name Required Type Description Format

networkLatency

Long

int64

connectionSpeed

Long

int64

retriesCount

Long

int64

3.13. ConnectorModel

Field Name Required Type Description Format

name

X

String

description

String

host

X

String

username

String

password

String

maxConnections

Integer

int32

3.14. ConnectorRepresentation

Field Name Required Type Description Format

name

String

description

String

status

String

Enum: ACTIVE, DELETED, SYNC_IN_PROGRESS, SYNC_ERROR, NOT_SYNCABLE,

statusDescription

String

host

String

username

String

password

String

syncedBy

String

syncedOn

Date

date-time

createdBy

String

createOn

Date

date-time

modifiedBy

String

modifiedOn

Date

date-time

connectorId

UUID

uuid

links

List of Link

3.15. ContextChange

Field Name Required Type Description Format

changedItem

ContextItem

changeType

String

Enum: ADD, MODIFY, DELETE,

3.16. ContextItem

Field Name Required Type Description Format

identifier

String

name

String

description

String

type

ContextTypeItem

events

List of Event

components

List of Component

fields

List of [map]

keywords

List of [string]

lastModifiedDate

String

errors

List of Error

3.17. ContextItemRepresentation

Field Name Required Type Description Format

identifier

String

name

String

description

String

type

ContextTypeItemModel

events

List of EventModel

components

List of ComponentModel

fields

List of [map]

keywords

List of [string]

lastModifiedDate

String

errors

List of ErrorModel

links

List of Link

3.18. ContextTypeItem

Field Name Required Type Description Format

identifier

String

name

String

workflowIdentifier

String

3.19. ContextTypeItemModel

Field Name Required Type Description Format

identifier

String

name

String

workflowIdentifier

String

3.20. ContextTypeRepresentation

Field Name Required Type Description Format

identifier

String

name

String

workflow

IdentifierModel

color

String

fields

List of IdentifierModel

links

List of Link

3.21. CursorPagedResourcesContextChange

Field Name Required Type Description Format

content

List of ContextChange

nextPage

String

3.22. Data

Field Name Required Type Description Format

type

String

Enum: DATA_REFERENCE, STRING_ARRAY, NUMERIC, STRING,

value

Object

3.23. DataReferenceData

Field Name Required Type Description Format

type

String

Enum: DATA_REFERENCE, STRING_ARRAY, NUMERIC, STRING,

value

String

3.24. DataReferenceDataAllOf

Field Name Required Type Description Format

value

String

3.25. DatasourceModel

Field Name Required Type Description Format

type

X

String

name

X

String

description

String

connectorId

UUID

uuid

connectionProperties

String

maxConnections

Integer

int32

onlySupportsRawValues

Boolean

maxPlotPeriodInDays

Integer

int32

capabilityTypes

Set of [string]

providerTypeProperties

Set of ProviderTypePropertyModel

3.26. DatasourceRepresentation

Field Name Required Type Description Format

type

String

name

String

description

String

connectionProperties

String

maxConnections

Integer

int32

onlySupportsRawValues

Boolean

status

String

Enum: ACTIVE, DELETED, SYNC_IN_PROGRESS, SYNC_ERROR, NOT_SYNCABLE,

statusDescription

String

syncedBy

String

syncedOn

Date

date-time

createdBy

String

createOn

Date

date-time

modifiedBy

String

modifiedOn

Date

date-time

indexingGranularity

String

maxPlotPeriodInDays

Integer

int32

capabilityTypes

Set of [string]

Enum:

connectorId

UUID

uuid

providerTypeProperties

Set of ProviderTypePropertyRepresentation

builtin

Boolean

datasourceId

UUID

uuid

links

List of Link

3.27. Dependency

Field Name Required Type Description Format

identifier

UUID

uuid

externalIdentifier

String

datasourceIdentifier

UUID

uuid

datasourceType

String

dependents

List of Dependency

dependencies

List of Dependency
Field Name Required Type Description Format

key

String

value

String

3.29. Error

Field Name Required Type Description Format

type

String

key

String

message

String

3.30. ErrorModel

Field Name Required Type Description Format

type

String

key

String

message

String

3.31. Event

Field Name Required Type Description Format

identifier

String

occurred

String

state

String

3.32. EventModel

Field Name Required Type Description Format

identifier

String

occurred

String

state

String

3.33. FieldRepresentation

Field Name Required Type Description Format

identifier

String

name

String

type

String

placeholder

String

options

List of [string]

links

List of Link

3.34. HistorianDetailsModel

Field Name Required Type Description Format

dbId

String

name

String

server

String

3.35. IdentifierModel

Field Name Required Type Description Format

identifier

String

3.36. ImportedTimeSeriesRepresentation

Field Name Required Type Description Format

identifier

UUID

uuid

name

String

description

String

unitOfMeasurement

String

timeSeriesType

String

Enum: ANALOG, DIGITAL, DISCRETE, STRING,

createOn

Date

date-time

links

List of Link

3.37. IndexHorizonRepresentation

Field Name Required Type Description Format

links

List of Link

horizon

Date

date-time

3.38. LegacyAccessibilityModel

Field Name Required Type Description Format

accessibility

String

Enum: accessible, denied, deleted, undefined,

3.39. LegacyStateModel

Field Name Required Type Description Format

Name

String

Code

Integer

int32

Offset

Integer

int32

3.40. LegacyTagDetailsModel

Field Name Required Type Description Format

id

String

name

String

description

String

interpolationType

String

units

String

source

String

startDate

Date

date-time

endDate

Date

date-time

deleted

Boolean

capabilities

CapabilitiesModel

historian

HistorianDetailsModel

Type

String

States

List of LegacyStateModel

type

String

Name

String

TagName

String
Field Name Required Type Description Format

rel

String

href

String

hreflang

String

media

String

title

String

type

String

deprecation

String

profile

String

name

String

3.42. NotImportedTimeSeries

Field Name Required Type Description Format

tagName

String

reason

String

details

Map of [string]

3.43. NumericData

Field Name Required Type Description Format

type

String

Enum: DATA_REFERENCE, STRING_ARRAY, NUMERIC, STRING,

value

BigDecimal

3.44. NumericDataAllOf

Field Name Required Type Description Format

value

BigDecimal

3.45. PageMetadata

Field Name Required Type Description Format

size

Long

int64

totalElements

Long

int64

totalPages

Long

int64

number

Long

int64

3.46. PagedModelConfigurationItemRepresentation

Field Name Required Type Description Format

links

List of Link

content

List of ConfigurationItemRepresentation

page

PageMetadata

3.47. PagedModelConnectorRepresentation

Field Name Required Type Description Format

links

List of Link

content

List of ConnectorRepresentation

page

PageMetadata

3.48. PagedModelContextItemRepresentation

Field Name Required Type Description Format

links

List of Link

content

List of ContextItemRepresentation

page

PageMetadata

3.49. PagedModelContextTypeRepresentation

Field Name Required Type Description Format

links

List of Link

content

List of ContextTypeRepresentation

page

PageMetadata

3.50. PagedModelDatasourceRepresentation

Field Name Required Type Description Format

links

List of Link

content

List of DatasourceRepresentation

page

PageMetadata

3.51. PagedModelFieldRepresentation

Field Name Required Type Description Format

links

List of Link

content

List of FieldRepresentation

page

PageMetadata

3.52. PagedModelImportedTimeSeriesRepresentation

Field Name Required Type Description Format

links

List of Link

content

List of ImportedTimeSeriesRepresentation

page

PageMetadata

3.53. PagedModelTimeSeriesDefinitionRepresentation

Field Name Required Type Description Format

links

List of Link

content

List of TimeSeriesDefinitionRepresentation

page

PageMetadata

3.54. PagedModelTimeSeriesRelationRepresentation

Field Name Required Type Description Format

links

List of Link

content

List of TimeSeriesRelationRepresentation

page

PageMetadata

3.55. PagedModelTimeSeriesValueMappingRepresesentation

Field Name Required Type Description Format

links

List of Link

content

List of TimeSeriesValueMappingRepresesentation

page

PageMetadata

3.56. PagedModelWorkflowRepresentation

Field Name Required Type Description Format

links

List of Link

content

List of WorkflowRepresentation

page

PageMetadata

3.57. ProviderMetaDataRepresentation

Field Name Required Type Description Format

name

String

label

String

experimental

Boolean

connectors

List of [string]

capabilities

Set of [string]

Enum:

properties

List of CapabilityProperty

links

List of Link

3.58. ProviderTypePropertyModel

Field Name Required Type Description Format

name

X

String

value

String

encrypted

Boolean

3.59. ProviderTypePropertyRepresentation

Field Name Required Type Description Format

name

String

value

String

encrypted

Boolean

links

List of Link

3.60. RsqlRequest

Field Name Required Type Description Format

query

X

String

3.61. StringArrayData

Field Name Required Type Description Format

type

String

Enum: DATA_REFERENCE, STRING_ARRAY, NUMERIC, STRING,

value

List of [string]

3.62. StringArrayDataAllOf

Field Name Required Type Description Format

value

List of [string]

3.63. StringData

Field Name Required Type Description Format

type

String

Enum: DATA_REFERENCE, STRING_ARRAY, NUMERIC, STRING,

value

String

3.64. Template

Field Name Required Type Description Format

identifier

String

name

String

3.65. TimeSeriesDefinitionModel

Field Name Required Type Description Format

id

UUID

uuid

datasourceId

X

UUID

uuid

externalId

String

name

X

String

description

String

type

X

String

Enum: ANALOG, DIGITAL, DISCRETE, STRING,

dependentTimeSeriesDefinitions

List of [UUID]

uuid

3.66. TimeSeriesDefinitionRepresentation

Field Name Required Type Description Format

datasourceId

UUID

uuid

ownerId

String

externalId

String

name

String

description

String

type

String

units

String

interpolationType

String

deleted

Boolean

plotDataUrl

String

indexDataUrl

String

links

List of Link

id

UUID

uuid

3.67. TimeSeriesDependencyTreeDefinitionRepresentation

Field Name Required Type Description Format

dependents

List of Dependency

dependencies

List of Dependency

links

List of Link

3.68. TimeSeriesRelationRepresentation

Field Name Required Type Description Format

timeSeriesId

UUID

uuid

timeSeriesExternalId

String

timeSeriesDatasourceId

UUID

uuid

relationTimeSeriesId

UUID

uuid

relationTimeSeriesExternalId

String

relationTimeSeriesDatasourceId

UUID

uuid

links

List of Link

3.69. TimeSeriesValueMappingRepresesentation

Field Name Required Type Description Format

timeSeriesId

UUID

uuid

stringValue

String

intValue

Integer

int32

links

List of Link

3.70. VersionInfo

Field Name Required Type Description Format

version

String

3.71. WorkflowRepresentation

Field Name Required Type Description Format

identifier

String

name

String

startState

String

endState

String

states

List of [string]

links

List of Link

Download PDF version | Download OpenAPI specifications