Reference · built on requestConnectorPLC, SCADA & MES

HighByte Intelligence Hub

Modeled instances, connection inputs and outputs, and pipeline endpoints from HighByte Intelligence Hub's REST Data Server.

About

HighByte Intelligence Hub is industrial DataOps software. Connections to OPC UA, MQTT, Sparkplug, Modbus TCP, SQL, historians, and cloud services expose Inputs, readable paths to data points, and Outputs, writable ones. Models define an asset or process as named, typed attributes, and Instances bind a model to real sources. The REST Data Server publishes inputs, outputs, instances, and pipelines with an enabled API Trigger as HTTP endpoints, documented by Swagger at /data/doc on port 8885.

Through Fibric, an operator reads instances on a schedule, compares them with the model's expectations, and proposes a call to a pipeline endpoint, such as a setpoint change or a work order request. You approve. Each call is made once and leaves a receipt: what changed, why, and how to undo it.

This is a reference listing. It documents what Fibric would read from HighByte Intelligence Hub and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Instances, each model attribute resolved from its Reference or Expression, read on demand from the REST Data Server
  • Connection Inputs, with cached values held from 10 milliseconds to 36 days when caching is enabled
  • Parameterized inputs and instances, such as a SQL input that takes a workOrderID
  • Pipelines exposed by an enabled API Trigger, with parameters that define the accepted JSON payload
  • Hub version, build, and license state from GET /v1/info on the Configuration API, which needs no authorization

Proposed actions

  • Target capability: propose calling an API Trigger pipeline that writes to an Output, such as a setpoint or a CreateWorkOrder request
  • Target capability: propose a partial project import through POST /v1/project/partial/import to add or update models, instances, or inputs
  • Target capability: propose exporting the project through GET /v1/project/export as a configuration backup

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Hold a setpoint change until someone signs it

    A pipeline exposes a setpoint write on an Output. The operator proposes the call with the new value and the instance reading that justified it, then waits for your approval before the pipeline runs.

    With Cycle Drift, Batch Deviation

  • Raise a work order from a modeled asset

    An instance attribute such as vibration crosses its threshold. The operator proposes a call to the CreateWorkOrder pipeline with machineID and message, and files the instance payload as evidence.

    With Predictive Maintenance, Inspection Due

  • Keep hub configuration under review

    The project export is read daily and compared with the last copy. The operator lists changed models, instances, and connections and proposes an annotation on the affected metrics.

    With Change Annotation, Audit Trail

Requirements

  • The REST Data Server enabled under Manage, Settings, with HTTPS enabled and a certificate you trust
  • A hub user with an API Key and claims for the resources and actions the operator needs
  • API Triggers enabled on each pipeline Fibric calls, with Return and Error stages to shape the response
  • Network reach to the hub on port 8885 for data and port 45245 for the Configuration API
Authentication
A bearer token: an API Key created under Manage, Users for the REST Data Server, or a token from POST /login with a username and password for the Configuration API; API keys are shown once.

Limits

  • Allow Anonymous is off by default; when enabled it exposes only read-only operations such as listing pipelines
  • Return stages answer 200 and pipeline errors 400 unless a Transform stage sets HTTPResponse.statusCode
  • Username and password login for the REST Data Server is off by default and not the recommended method
  • Input and output names allow only alphanumeric and underscore characters

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request HighByte Intelligence Hub ↗

Questions and answers

Where is the REST Data Server API documented?
In the hub itself. Once the server is enabled, Swagger documentation opens at http://localhost:8885/data/doc by default. Some endpoints need a bearer token to try from that page.
What is the difference between the REST Data Server and the Project API?
The REST Data Server serves data: inputs, outputs, instances, and pipelines. The Project API on port 45245 exports and imports configuration as JSON through /v1/project/export, /v1/project/import, and /v1/project/partial/import, and is meant for CI/CD, backup, and mass configuration.
How does a pipeline become an HTTP endpoint?
Enable its API Trigger. Parameters on the trigger define the JSON payload the pipeline accepts; requests that do not match fail. Return and Error stages decide what the caller receives.
Ask about HighByte Intelligence Hub

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.