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

200

Ok

AssetRepresentation

404

The resource was not found

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

200

Ok

List[[AssetRepresentation]]

404

The resource was not found

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

200

Ok

List[[AssetRepresentation]]

404

The resource was not found

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

200

Successfully updated configuration item

ConfigurationItemRepresentation

404

The configuration item was not found

ConfigurationItemRepresentation

204

No Content

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

204

No content

404

The resource was not found

202

Accepted

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

200

Ok

ConnectorRepresentation

404

The resource was not found

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

200

Ok

VersionInfo

404

The resource was not found

VersionInfo
Produces

  • application/json

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

200

Ok

404

The resource was not found

202

Accepted

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

200

Ok

ConnectionTest

404

The resource was not found

ConnectionTest
Produces

  • application/json

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

200

Ok

ConnectorRepresentation

400

Bad Request

ConnectorRepresentation

404

The resource was not found

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

200

Ok

CursorPagedResourcesContextChange

501

Datasource does not support 'CONTEXT' capability

CursorPagedResourcesContextChange

404

The resource was not found

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

200

Ok

PagedModelFieldRepresentation

501

Datasource does not support 'CONTEXT' capability

PagedModelFieldRepresentation

404

The resource was not found

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

200

Ok

ContextItemRepresentation

501

Datasource does not support 'CONTEXT' capability

ContextItemRepresentation

404

The resource was not found

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

200

Ok

PagedModelContextItemRepresentation

501

Datasource does not support 'CONTEXT' capability

PagedModelContextItemRepresentation

404

The resource was not found

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

200

Ok

List[[ContextItemRepresentation]]

501

Datasource does not support 'CONTEXT' capability

List[[ContextItemRepresentation]]

404

The resource was not found

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

200

Ok

PagedModelContextTypeRepresentation

501

Datasource does not support 'CONTEXT' capability

PagedModelContextTypeRepresentation

404

The resource was not found

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

200

Ok

PagedModelWorkflowRepresentation

501

Datasource does not support 'CONTEXT' capability

PagedModelWorkflowRepresentation

404

The resource was not found

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

204

No content

404

The resource was not found

202

Accepted

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

200

Ok

DatasourceRepresentation

404

The resource was not found

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. Search datasources

GET /datasources/search

Parameters

Type

Name

Description

Schema

Query

optional

types

The datasource type

Query

optional

capabilityTypes

The capability type

Query

optional

name

The name of the datasource

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.6. 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

200

Ok

404

The resource was not found

202

Accepted

2.5.7. Test datasource connection status.

POST /datasources/test

Parameters

Type

Name

Description

Schema

Body

required

DatasourceModel

[DatasourceModel]
Responses

HTTP Code

Description

Schema

200

Ok

ConnectionStatus
Produces

  • /

2.5.8. Test datasource connection status.

POST /datasources/{id}/test

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID
Responses

HTTP Code

Description

Schema

200

Ok

ConnectionStatus

404

The resource was not found

ConnectionStatus
Produces

  • /

2.5.9. 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

200

Ok

DatasourceRepresentation

400

Bad Request

DatasourceRepresentation

404

The resource was not found

DatasourceRepresentation
Produces

  • application/json

2.6. Event

2.6.1. Write an event back to the source.

POST /datasources/{id}/events/event

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID

Body

required

EventModel

[EventModel]
Responses

HTTP Code

Description

Schema

404

The datasource id does not exist

EventRepresentation

201

Created

EventRepresentation

501

Provider type does not support 'EVENT_WRITE' capability

EventRepresentation

500

Remote source server exception

EventRepresentation
Produces

  • application/json

2.6.2. Get the event for the specified identifier.

GET /datasources/{id}/event/events/{eventId}

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID

Path required

eventId

The identifier of the event

String
Responses

HTTP Code

Description

Schema

200

Ok

EventRepresentation

501

Datasource does not support 'EVENT' capability

EventRepresentation

404

The resource was not found

EventRepresentation
Produces

  • application/json

  • application/hal+json

2.6.3. Get the event type for the specified identifier.

GET /datasources/{id}/events/type/{typeId}

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID

Path required

typeId

The identifier of the type

String
Responses

HTTP Code

Description

Schema

200

Ok

EventTypeRepresentation

501

Datasource does not support 'EVENT' capability

EventTypeRepresentation

404

The resource was not found

EventTypeRepresentation
Produces

  • application/json

  • application/hal+json

2.6.4. Get all event type definitions

GET /datasources/{id}/events/type

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID

Query

optional

continuationToken

cursor

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

CursorPagedModelEventTypeRepresentation

501

Datasource does not support 'EVENT' capability

CursorPagedModelEventTypeRepresentation

404

The resource was not found

CursorPagedModelEventTypeRepresentation
Produces

  • application/json

  • application/stream+json

2.6.5. Get all events after a given date

GET /datasources/{id}/events/event

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID

Query

required

after

Events occurring after a specific date. Internet DateTime format, see RFC3339 e.g.: '2012-01-01T00:00:00Z’.

Query

optional

before

Events occurring before a specific date. Internet DateTime format, see RFC3339 e.g.: '2012-01-01T00:00:00Z’.

Query

optional

continuationToken

cursor

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

CursorPagedModelEventRepresentation

501

Datasource does not support 'EVENT' capability

CursorPagedModelEventRepresentation

404

The resource was not found

CursorPagedModelEventRepresentation
Produces

  • application/json

  • application/stream+json

2.6.6. Get all events based on a grouping key

GET /datasources/{id}/events/groupedevent

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID

Query

required

groupingKey

Events belonging together are grouped by a grouping key

Query

optional

continuationToken

cursor

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

CursorPagedModelEventRepresentation

501

Datasource does not support 'EVENT' capability

CursorPagedModelEventRepresentation

404

The resource was not found

CursorPagedModelEventRepresentation
Produces

  • application/json

  • application/stream+json

2.6.7. Get the field for the specified identifier.

GET /datasources/{id}/events/field/{fieldId}

Parameters

Type

Name

Description

Schema

Path required

id

The identifier for the datasource

UUID

Path required

fieldId

The identifier for the field

String
Responses

HTTP Code

Description

Schema

200

Ok

EventFieldRepresentation

501

Datasource does not support 'EVENT' capability

EventFieldRepresentation

404

The resource was not found

EventFieldRepresentation
Produces

  • application/json

  • application/hal+json

2.6.8. Get all field definitions

GET /datasources/{id}/events/field

Parameters

Type

Name

Description

Schema

Path required

id

The identifier of the datasource

UUID

Query

optional

continuationToken

cursor

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

CursorPagedModelEventFieldRepresentation

501

Datasource does not support 'EVENT' capability

CursorPagedModelEventFieldRepresentation

404

The resource was not found

CursorPagedModelEventFieldRepresentation
Produces

  • application/json

  • application/stream+json

2.7. ImportedTimeSeries

2.7.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

204

No content

404

The resource was not found

2.7.2. Delete all imported time series.

DELETE /imported/timeseries/

Parameters
Type Name Description Schema
Responses

HTTP Code

Description

Schema

204

No content

404

The resource was not found

2.7.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

200

Ok

ImportedTimeSeriesRepresentation

404

The resource was not found

ImportedTimeSeriesRepresentation
Produces

  • application/json

2.7.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.7.5. Imports time series from a csv file

POST /imported/timeseries

Parameters
Type Name Description Schema
Responses

HTTP Code

Description

Schema

422

Validation error

List[[NotImportedTimeSeries]]

204

Valid

List[[NotImportedTimeSeries]]

400

Bad Request

List[[NotImportedTimeSeries]]

200

OK

List[[NotImportedTimeSeries]]
Produces

  • /

2.8. LegacyTimeSeries

2.8.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

200

Ok

LegacyTagDetailsModel

404

The resource was not found

LegacyTagDetailsModel
Produces

  • application/json

2.8.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

200

Ok

LegacyAccessibilityModel

404

The resource was not found

LegacyAccessibilityModel
Produces

  • application/json

2.8.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

200

Ok

LegacyTagDetailsModel

404

The resource was not found

LegacyTagDetailsModel
Produces

  • application/json

2.8.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

200

Ok

List[[LegacyStateModel]]

404

The resource was not found

List[[LegacyStateModel]]
Produces

  • application/json

2.9. MetricsController

GET /datasources/{id}/metrics

===== Parameters

Type

Name

Description

Schema

Path required

id

UUID

===== Responses

HTTP Code

Description

Schema

200

OK

MetricRepresentation

===== Produces

  • application/json

  • application/hal+json

=== Providers

==== 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

==== 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

=== TimeSeries

==== 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

==== 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

==== 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

==== 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

==== 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

==== 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

204

No content

404

The resource was not found

==== 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

204

No content

404

The resource was not found

==== 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

200

Ok

TimeSeriesValueMappingRepresesentation

404

The resource was not found

TimeSeriesValueMappingRepresesentation

===== Produces

  • application/json

==== 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

200

Ok

TimeSeriesDefinitionRepresentation

404

The resource was not found

TimeSeriesDefinitionRepresentation

===== Produces

  • application/json

==== 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

200

Ok

TimeSeriesDependencyTreeDefinitionRepresentation

404

The resource was not found

TimeSeriesDependencyTreeDefinitionRepresentation

===== Produces

  • application/json

==== 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

200

Ok

TimeSeriesDependencyTreeDefinitionRepresentation

404

The resource was not found

TimeSeriesDependencyTreeDefinitionRepresentation

===== Produces

  • application/json

==== 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

==== 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

200

Ok

PagedModelTimeSeriesValueMappingRepresesentation

404

The resource was not found

PagedModelTimeSeriesValueMappingRepresesentation

===== Produces

  • application/json

  • application/hal+json

==== 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

required

ValueMappingRequestModel

Model containing the identifiers of the value mappings in a int list

[ValueMappingRequestModel]

===== Responses

HTTP Code

Description

Schema

200

Ok

List[[TimeSeriesValueMappingRepresesentation]]

404

The resource was not found

List[[TimeSeriesValueMappingRepresesentation]]

===== Produces

  • application/json

  • application/hal+json

==== Effective index horizon GET /timeseries/indexhorizon

===== Parameters

Type Name Description Schema

===== Responses

HTTP Code

Description

Schema

200

OK

IndexHorizonRepresentation

===== Produces

  • application/json

==== 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

==== 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

==== 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

200

Ok

PagedModelTimeSeriesValueMappingRepresesentation

404

The resource was not found

PagedModelTimeSeriesValueMappingRepresesentation

===== Produces

  • application/json

  • application/hal+json

==== 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

200

Ok

TimeSeriesDefinitionRepresentation

400

Bad Request

TimeSeriesDefinitionRepresentation

404

The resource was not found

TimeSeriesDefinitionRepresentation

201

Created

TimeSeriesDefinitionRepresentation

===== Produces

  • application/json

==== 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

200

Ok

TimeSeriesDefinitionRepresentation

400

Bad Request

TimeSeriesDefinitionRepresentation

404

The resource was not found

TimeSeriesDefinitionRepresentation

201

Created

TimeSeriesDefinitionRepresentation

===== Produces

  • application/json

== Models

=== AdvancedSearchRequest

Field Name Required Type Description Format

name

String

description

String

datasources

List of [UUID]

uuid

=== Asset

Field Name Required Type Description Format

identifier

String

parentIdentifier

String

type

String

template

Template

data

Data

name

String

description

String

=== 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]

=== BasicSearchRequest

Field Name Required Type Description Format

query

X

String

datasources

List of [UUID]

uuid

=== BoolCapabilityProperty

Field Name Required Type Description Format

name

String

label

String

type

String

Enum: SINGLE_LINE, MULTI_LINE, BOOL, DROPDOWN, BOOL_GROUP,

capabilities

List of [string]

Enum:

required

Boolean

=== BoolGroupCapabilityProperty

Field Name Required Type Description Format

name

String

label

String

type

String

Enum: SINGLE_LINE, MULTI_LINE, BOOL, DROPDOWN, BOOL_GROUP,

capabilities

List of [string]

Enum:

required

Boolean

groupType

String

=== BoolGroupCapabilityPropertyAllOf

Field Name Required Type Description Format

groupType

String

=== CapabilitiesModel

Field Name Required Type Description Format

canChangeInterpolationType

Boolean

=== CapabilityProperty

Field Name Required Type Description Format

name

String

label

String

type

String

Enum: SINGLE_LINE, MULTI_LINE, BOOL, DROPDOWN, BOOL_GROUP,

capabilities

List of [string]

Enum:

required

Boolean

=== CollectionModelTimeSeriesDefinitionRepresentation

Field Name Required Type Description Format

links

List of [Link]

content

List of [TimeSeriesDefinitionRepresentation]

=== Component

Field Name Required Type Description Format

identifier

String

type

String

Enum: TAG, ATTRIBUTE, ASSET,

=== ComponentModel

Field Name Required Type Description Format

identifier

String

type

String

=== 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]

=== ConnectionStatus

Field Name Required Type Description Format

healthy

Boolean

=== ConnectionTest

Field Name Required Type Description Format

networkLatency

Long

int64

connectionSpeed

Long

int64

retriesCount

Long

int64

=== ConnectorModel

Field Name Required Type Description Format

name

X

String

description

String

host

X

String

username

String

password

String

maxConnections

Integer

int32

=== 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]

=== ContextChange

Field Name Required Type Description Format

changedItem

ContextItem

changeType

String

Enum: ADD, MODIFY, DELETE,

=== 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]

=== 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]

=== ContextTypeItem

Field Name Required Type Description Format

identifier

String

name

String

workflowIdentifier

String

=== ContextTypeItemModel

Field Name Required Type Description Format

identifier

String

name

String

workflowIdentifier

String

=== ContextTypeRepresentation

Field Name Required Type Description Format

identifier

String

name

String

workflow

IdentifierModel

color

String

fields

List of [IdentifierModel]

links

List of [Link]

=== CursorPageMetadata

Field Name Required Type Description Format

size

Long

int64

hasNext

Boolean

continuationToken

String

=== CursorPagedModelEventFieldRepresentation

Field Name Required Type Description Format

links

List of [Link]

content

List of [EventFieldRepresentation]

page

CursorPageMetadata

=== CursorPagedModelEventRepresentation

Field Name Required Type Description Format

links

List of [Link]

content

List of [EventRepresentation]

page

CursorPageMetadata

=== CursorPagedModelEventTypeRepresentation

Field Name Required Type Description Format

links

List of [Link]

content

List of [EventTypeRepresentation]

page

CursorPageMetadata

=== CursorPagedResourcesContextChange

Field Name Required Type Description Format

content

List of [ContextChange]

nextPage

String

=== Data

Field Name Required Type Description Format

type

String

Enum: DATA_REFERENCE, STRING_ARRAY, NUMERIC, STRING,

value

Object

=== DataReferenceData

Field Name Required Type Description Format

type

String

Enum: DATA_REFERENCE, STRING_ARRAY, NUMERIC, STRING,

value

String

=== DataReferenceDataAllOf

Field Name Required Type Description Format

value

String

=== DatasourceModel

Field Name Required Type Description Format

type

X

String

name

X

String

description

String

connectorId

UUID

uuid

datasourceId

UUID

uuid

maxConnections

Integer

int32

onlySupportsRawValues

Boolean

maxPlotPeriodInDays

Integer

int32

capabilityTypes

Set of [string]

providerTypeProperties

Set of [ProviderTypePropertyModel]

=== DatasourceRepresentation

Field Name Required Type Description Format

type

String

name

String

description

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]

=== 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

name

String

label

String

type

String

Enum: SINGLE_LINE, MULTI_LINE, BOOL, DROPDOWN, BOOL_GROUP,

capabilities

List of [string]

Enum:

required

Boolean

options

List of [DropDownOption]
Field Name Required Type Description Format

options

List of [DropDownOption]
Field Name Required Type Description Format

key

String

value

String

=== Error

Field Name Required Type Description Format

type

String

key

String

message

String

=== ErrorModel

Field Name Required Type Description Format

type

String

key

String

message

String

=== Event

Field Name Required Type Description Format

identifier

String

occurred

String

state

String

=== EventFieldRepresentation

Field Name Required Type Description Format

identifier

String

name

String

type

String

Enum: STRING, NUMERIC, ENUMERATION,

placeholder

String

options

List of [string]

links

List of [Link]

=== EventModel

Field Name Required Type Description Format

identifier

String

name

String

description

String

type

EventTypeModel

state

String

occurredAt

Date

date-time

modifiedAt

Date

date-time

components

List of [ComponentModel]

fields

List of [map]

keywords

List of [string]

errors

List of [ErrorModel]

groupingKey

String

=== EventRepresentation

Field Name Required Type Description Format

identifier

String

name

String

description

String

type

EventType

state

String

occurredAt

Date

date-time

modifiedAt

Date

date-time

components

List of [Component]

fields

List of [map]

keywords

List of [string]

errors

List of [Error]

groupingKey

String

links

List of [Link]

=== EventType

Field Name Required Type Description Format

identifier

String

name

String

color

String

startState

String

endState

String

states

List of [string]

fields

List of [Identifier]

=== EventTypeModel

Field Name Required Type Description Format

identifier

String

name

String

color

String

startState

String

endState

String

states

List of [string]

fields

List of [IdentifierModel]

write

Boolean

=== EventTypeRepresentation

Field Name Required Type Description Format

identifier

String

name

String

color

String

startState

String

endState

String

states

List of [string]

fields

List of [Identifier]

links

List of [Link]

=== FieldRepresentation

Field Name Required Type Description Format

identifier

String

name

String

type

String

placeholder

String

options

List of [string]

links

List of [Link]

=== HistorianDetailsModel

Field Name Required Type Description Format

dbId

String

name

String

server

String

=== Identifier

Field Name Required Type Description Format

identifier

String

=== IdentifierModel

Field Name Required Type Description Format

identifier

String

=== 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]

=== IndexHorizonRepresentation

Field Name Required Type Description Format

links

List of [Link]

horizon

Date

date-time

=== LegacyAccessibilityModel

Field Name Required Type Description Format

accessibility

String

Enum: accessible, denied, deleted, undefined,

=== LegacyStateModel

Field Name Required Type Description Format

Name

String

Code

Integer

int32

Offset

Integer

int32

=== 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

=== MetricRepresentation

Field Name Required Type Description Format

datasourceId

UUID

uuid

datasourceIndex95pInMillis

Long

int64

datasourceIndex50pInMillis

Long

int64

datasourcePlot95pInMillis

Long

int64

datasourcePlot50pInMillis

Long

int64

datasourceSync95pInMillis

Long

int64

datasourceSync50pInMillis

Long

int64

connectorId

UUID

uuid

connectorIndex95pInMillis

Long

int64

connectorIndex50pInMillis

Long

int64

connectorPlot95pInMillis

Long

int64

connectorPlot50pInMillis

Long

int64

connectorSync50pInMillis

Long

int64

connectorSync95pInMillis

Long

int64

links

List of [Link]

=== MultiLineCapabilityProperty

Field Name Required Type Description Format

name

String

label

String

type

String

Enum: SINGLE_LINE, MULTI_LINE, BOOL, DROPDOWN, BOOL_GROUP,

capabilities

List of [string]

Enum:

required

Boolean

placeholder

String

=== MultiLineCapabilityPropertyAllOf

Field Name Required Type Description Format

placeholder

String

=== NotImportedTimeSeries

Field Name Required Type Description Format

tagName

String

reason

String

details

Map of [string]

=== NumericData

Field Name Required Type Description Format

type

String

Enum: DATA_REFERENCE, STRING_ARRAY, NUMERIC, STRING,

value

BigDecimal

=== NumericDataAllOf

Field Name Required Type Description Format

value

BigDecimal

=== PageMetadata

Field Name Required Type Description Format

size

Long

int64

totalElements

Long

int64

totalPages

Long

int64

number

Long

int64

=== PagedModelConfigurationItemRepresentation

Field Name Required Type Description Format

links

List of [Link]

content

List of [ConfigurationItemRepresentation]

page

PageMetadata

=== PagedModelConnectorRepresentation

Field Name Required Type Description Format

links

List of [Link]

content

List of [ConnectorRepresentation]

page

PageMetadata

=== PagedModelContextItemRepresentation

Field Name Required Type Description Format

links

List of [Link]

content

List of [ContextItemRepresentation]

page

PageMetadata

=== PagedModelContextTypeRepresentation

Field Name Required Type Description Format

links

List of [Link]

content

List of [ContextTypeRepresentation]

page

PageMetadata

=== PagedModelDatasourceRepresentation

Field Name Required Type Description Format

links

List of [Link]

content

List of [DatasourceRepresentation]

page

PageMetadata

=== PagedModelFieldRepresentation

Field Name Required Type Description Format

links

List of [Link]

content

List of [FieldRepresentation]

page

PageMetadata

=== PagedModelImportedTimeSeriesRepresentation

Field Name Required Type Description Format

links

List of [Link]

content

List of [ImportedTimeSeriesRepresentation]

page

PageMetadata

=== PagedModelTimeSeriesDefinitionRepresentation

Field Name Required Type Description Format

links

List of [Link]

content

List of [TimeSeriesDefinitionRepresentation]

page

PageMetadata

=== PagedModelTimeSeriesRelationRepresentation

Field Name Required Type Description Format

links

List of [Link]

content

List of [TimeSeriesRelationRepresentation]

page

PageMetadata

=== PagedModelTimeSeriesValueMappingRepresesentation

Field Name Required Type Description Format

links

List of [Link]

content

List of [TimeSeriesValueMappingRepresesentation]

page

PageMetadata

=== PagedModelWorkflowRepresentation

Field Name Required Type Description Format

links

List of [Link]

content

List of [WorkflowRepresentation]

page

PageMetadata

=== 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 BoolGroupCapabilityProperty,DropDownCapabilityProperty,MultiLineCapabilityProperty,SingleLineCapabilityProperty>

links

List of [Link]

=== ProviderTypePropertyModel

Field Name Required Type Description Format

name

X

String

value

String

encrypted

Boolean

=== ProviderTypePropertyRepresentation

Field Name Required Type Description Format

name

String

value

String

encrypted

Boolean

links

List of [Link]

=== RsqlRequest

Field Name Required Type Description Format

query

X

String

=== SingleLineCapabilityProperty

Field Name Required Type Description Format

name

String

label

String

type

String

Enum: SINGLE_LINE, MULTI_LINE, BOOL, DROPDOWN, BOOL_GROUP,

capabilities

List of [string]

Enum:

required

Boolean

placeholder

String

encrypted

Boolean

=== SingleLineCapabilityPropertyAllOf

Field Name Required Type Description Format

placeholder

String

encrypted

Boolean

=== StringArrayData

Field Name Required Type Description Format

type

String

Enum: DATA_REFERENCE, STRING_ARRAY, NUMERIC, STRING,

value

List of [string]

=== StringArrayDataAllOf

Field Name Required Type Description Format

value

List of [string]

=== StringData

Field Name Required Type Description Format

type

String

Enum: DATA_REFERENCE, STRING_ARRAY, NUMERIC, STRING,

value

String

=== Template

Field Name Required Type Description Format

identifier

String

name

String

=== 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

=== TimeSeriesDefinitionRepresentation

Field Name Required Type Description Format

datasourceId

UUID

uuid

ownerId

String

externalId

String

name

String

description

String

type

String

units

String

interpolationType

String

datasourceType

String

deleted

Boolean

plotDataUrl

String

indexDataUrl

String

links

List of [Link]

id

UUID

uuid

=== TimeSeriesDependencyTreeDefinitionRepresentation

Field Name Required Type Description Format

dependents

List of [Dependency]

dependencies

List of [Dependency]

links

List of [Link]

=== 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]

=== TimeSeriesValueMappingRepresesentation

Field Name Required Type Description Format

timeSeriesId

UUID

uuid

stringValue

String

intValue

Integer

int32

links

List of [Link]

=== ValueMappingRequestModel

Field Name Required Type Description Format

intValues

List of [integer]

int32

=== VersionInfo

Field Name Required Type Description Format

version

String

=== 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