Sidebar
Overview
Resources
Datastream
The Datastream resource represents a stream of data associated with an industrial asset within the digital customer platform. It encapsulates the continuous flow of data points generated by sensors, machines, or manual inputs tied to a specific device or component. Datastreams are used to capture, store, and process real-time operational data, enabling users to monitor and analyze performance, conduct predictive maintenance, and make informed decisions based on the current and historical states of their assets. Each Datastream is uniquely identified and can be associated with various attributes such as name, type, and topic. They are central to the platform's capability to integrate with IoT devices and handle complex industrial data workloads.Attributes
These are all attributes that can be read and updated through the API
Name | Description | Permissions |
---|---|---|
name | The 'name' attribute represents the unique identifier for a particular datastream instance. It should be descriptive and indicate the data's purpose or origin to facilitate easy identification. | READ AND UPDATE |
type | The 'type' attribute specifies the nature or format of the data flowing through the datastream, such as 'JSON', 'XML', 'text', or any other data type definition required by the system. | READ AND UPDATE |
topic | The 'topic' attribute defines the categorization or subject matter that the datastream covers, often used in publish/subscribe messaging systems to allow subscribers to receive relevant data based on interests or processing needs. | READ AND UPDATE |
id_slug | A unique identifier for the Datastream, typically a machine-readable string that is used to reference the Datastream in API calls and database operations. It often combines an ID with a human-readable slug to enhance readability and SEO. | READ AND UPDATE |
Get Datastream by ID
GEThttps://connect.autonoma.cloud/v1/resources/datastream/[ID]Returns a specific Datastream by ID.
Relations
It is possible to get related objects from Datastreams.
GEThttps://connect.autonoma.cloud/v1/resources/datastream/[ID]/[RELATION]This table shows all available resources that can be queried
Relation | Objecttype | Relationtype | |
---|---|---|---|
device | Asset | 1:1 | Show details |
decodes | Decode | many:many | Show details |
metadatas | Metadata | many:many | Show details |
Update Datastream
POSThttps://connect.autonoma.cloud/v1/resources/datastream/[ID]Update fields of Datastream by ID. The fields must be sent as x-www-form-urlencoded parameter.
Create Datastream
PUThttps://connect.autonoma.cloud/v1/resources/datastreamCreate a new Datastream.
Delete Datastream
DELETEhttps://connect.autonoma.cloud/v1/resources/datastream/[ID]Delete the resource Datastream by ID.
This action can not be reverted!