AVEVA CONNECT data services

Technical Preview

Overview

A client-mode connector for a curated slice of AVEVA CONNECT data services (formerly AVEVA Data Hub / OSIsoft Cloud Services) under your regional host https://{region}.datahub.connect.aveva.com/api/v1/Tenants/{tenant}/Namespaces/{ns}:

Catalog connector event	Entity / path	Notes
(smoke)	`GET /Streams`	List SDS streams in the namespace
POST omf (type)	`POST /omf` + `MessageType: type`	OMF type → SDS type
POST omf (container)	`POST /omf` + `MessageType: container`	OMF container → SDS stream
POST omf (data)	`POST /omf` + `MessageType: data`	High-throughput async ingest (expects 202)
GET Streams/{id}/Data	`GET /Streams/{streamId}/Data?startIndex=`	Also `endIndex` / `count`
PUT Streams/{id}/Data	`PUT /Streams/{streamId}/Data`	Update/upsert SDS values

BASE_ADDRESS includes tenant and namespace (no trailing slash; endpoints start with /). Topics use historian/aveva-connect-data-services/<object>/<verb>. Default stub region is uswe (US West). See the base guide: REST API Connectors.

Tenant + OAuth required. There is no public CONNECT sandbox. Replace YOUR_TENANT / YOUR_NAMESPACE, pick your region, and supply an OAuth 2.0 client credentials access token. Prefer Hub secrets.

OMF connection. For POST /omf, map the client-credentials client to an OMF connection that targets the namespace (CONNECT portal: Data Management → Connections). Otherwise OMF ingress is unauthorized or not routed.

Prefer Hub secrets for tokens / client secrets. This template has not been verified against a live CONNECT tenant. Queue status remains blocked until an authenticated live smoke succeeds.

Basic Syntax

# Coreflux REST_API template — AVEVA CONNECT data services
# Auth: OAuth 2.0 client credentials → Bearer {value.json.api_token}
# BASE_ADDRESS: https://uswe.datahub.connect.aveva.com/api/v1/Tenants/YOUR_TENANT/Namespaces/YOUR_NAMESPACE

DEFINE ROUTE AvevaConnectDataServicesRestApi WITH TYPE REST_API
    ADD REST_API_CONFIG
        WITH BASE_ADDRESS "https://uswe.datahub.connect.aveva.com/api/v1/Tenants/YOUR_TENANT/Namespaces/YOUR_NAMESPACE"
        WITH ENABLE_CLIENT "true"
        WITH USE_SSL "true"
        WITH REQUEST_TIMEOUT '60'
        WITH DEFAULT_CONTENT_TYPE "application/json"
    ADD EVENT ListStreams
        WITH SOURCE_TOPIC "historian/aveva-connect-data-services/streams/list"
        WITH DESTINATION_TOPIC "historian/aveva-connect-data-services/streams/list/response"
        WITH METHOD "GET"
        WITH ENDPOINT "/Streams"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "Authorization" "Bearer {value.json.api_token}"
    ADD EVENT PostOmfType
        WITH SOURCE_TOPIC "historian/aveva-connect-data-services/omf/type"
        WITH DESTINATION_TOPIC "historian/aveva-connect-data-services/omf/type/response"
        WITH METHOD "POST"
        WITH ENDPOINT "/omf"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "Content-Type" "application/json"
            ADD "Authorization" "Bearer {value.json.api_token}"
            ADD "MessageType" "type"
            ADD "MessageFormat" "json"
            ADD "OmfVersion" "1.2"
        WITH BODY "{payload}"
    ADD EVENT PostOmfContainer
        WITH SOURCE_TOPIC "historian/aveva-connect-data-services/omf/container"
        WITH DESTINATION_TOPIC "historian/aveva-connect-data-services/omf/container/response"
        WITH METHOD "POST"
        WITH ENDPOINT "/omf"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "Content-Type" "application/json"
            ADD "Authorization" "Bearer {value.json.api_token}"
            ADD "MessageType" "container"
            ADD "MessageFormat" "json"
            ADD "OmfVersion" "1.2"
        WITH BODY "{payload}"
    ADD EVENT PostOmfData
        WITH SOURCE_TOPIC "historian/aveva-connect-data-services/omf/data"
        WITH DESTINATION_TOPIC "historian/aveva-connect-data-services/omf/data/response"
        WITH METHOD "POST"
        WITH ENDPOINT "/omf"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "Content-Type" "application/json"
            ADD "Authorization" "Bearer {value.json.api_token}"
            ADD "MessageType" "data"
            ADD "MessageFormat" "json"
            ADD "OmfVersion" "1.2"
        WITH BODY "{payload}"
    ADD EVENT GetStreamData
        WITH SOURCE_TOPIC "historian/aveva-connect-data-services/streams/data/get"
        WITH DESTINATION_TOPIC "historian/aveva-connect-data-services/streams/data/get/response"
        WITH METHOD "GET"
        WITH ENDPOINT "/Streams/{value.json.streamId}/Data?startIndex={value.json.startIndex}&endIndex={value.json.endIndex}&count={value.json.count}"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "Authorization" "Bearer {value.json.api_token}"
    ADD EVENT PutStreamData
        WITH SOURCE_TOPIC "historian/aveva-connect-data-services/streams/data/put"
        WITH DESTINATION_TOPIC "historian/aveva-connect-data-services/streams/data/put/response"
        WITH METHOD "PUT"
        WITH ENDPOINT "/Streams/{value.json.streamId}/Data"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "Content-Type" "application/json"
            ADD "Authorization" "Bearer {value.json.api_token}"
        WITH BODY "{payload}"

Events

Event	Method	Endpoint	Request topic	Response topic
ListStreams	GET	`/Streams`	`historian/aveva-connect-data-services/streams/list`	`.../response`
PostOmfType	POST	`/omf` (`MessageType: type`)	`.../omf/type`	`.../response`
PostOmfContainer	POST	`/omf` (`MessageType: container`)	`.../omf/container`	`.../response`
PostOmfData	POST	`/omf` (`MessageType: data`)	`.../omf/data`	`.../response`
GetStreamData	GET	`/Streams/{streamId}/Data?startIndex=&endIndex=&count=`	`.../streams/data/get`	`.../response`
PutStreamData	PUT	`/Streams/{streamId}/Data`	`.../streams/data/put`	`.../response`

Auth

Create a Client-Credentials client in CONNECT (Security → Clients) with roles that can read/write SDS streams (and OMF if ingesting).
For OMF, create an OMF connection and map that client to the target namespace(s).
Exchange credentials at the regional token endpoint, e.g.
POST https://uswe.datahub.connect.aveva.com/identity/connect/token
with grant_type=client_credentials, client_id, client_secret.
Discovery: https://uswe.datahub.connect.aveva.com/identity/.well-known/openid-configuration.
Pass the access token on each MQTT payload as api_token → header Authorization: Bearer {value.json.api_token}.
Prefer Hub secrets. Never commit client_secret or access tokens.

Example payloads

List streams (smoke):

{
  "api_token": "YOUR_OAUTH_ACCESS_TOKEN"
}

OMF data message (body is OMF JSON; MessageType is set by the event headers):

[
  {
    "containerid": "SimpleStream",
    "values": [
      {
        "Time": "2026-10-04T10:00:00Z",
        "Measurement": 42.5
      }
    ]
  }
]

Publish that array as the MQTT payload (and include api_token in a wrapper only if your upstream strips non-body keys before {payload} — otherwise publish the OMF body alone and pass the token via a Hub secret injection pattern your broker supports). Practical pattern: put api_token alongside path fields when the connector uses {value.json.*} for path/query, and keep {payload} as the full MQTT JSON for PUT/POST when the API accepts extra fields being ignored — for OMF, prefer a clean OMF array body. Get stream data:

{
  "api_token": "YOUR_OAUTH_ACCESS_TOKEN",
  "streamId": "SimpleStream",
  "startIndex": "2026-10-04T00:00:00Z",
  "endIndex": "2026-10-04T23:59:59Z",
  "count": "1000"
}

Put stream data:

[
  {
    "Time": "2026-10-04T10:00:00Z",
    "State": 0,
    "Measurement": 123.45
  }
]

Use streamId in the MQTT JSON for the path placeholder; shape the body as an SDS value array.

Configuration checklist

Set BASE_ADDRESS region + tenant + namespace.
Store OAuth client id/secret (or a short-lived access token) in Hub secrets.
Map the client to an OMF connection before using PostOmf*.
Deploy the .lot with -addRoute (no ADD METADATA in the deployable file).
Smoke: publish to historian/aveva-connect-data-services/streams/list → expect HTTP 200 on the response topic.

Sources

REST API Connectors
AVEVA PI Web API (on-prem sister historian package)
REST API Apps catalog

Quick Start

Coreflux MQTT Broker

LoT Language

Coreflux HUB

VS Code - LoT Notebooks

Coreflux Portal

Using AI with Coreflux

Product Updates

Overview

Basic Syntax

Events

Auth

Example payloads

Configuration checklist

Sources

​Overview

​Basic Syntax

​Events

​Auth

​Example payloads

​Configuration checklist

​Sources

​Related

Overview

Basic Syntax

Events

Auth

Example payloads

Configuration checklist

Sources

Related