Sidebar
Overview
Resources
Gateway
The Gateway resource represents a critical component within the digital customer platform that acts as a central communication hub for connecting various devices within an industrial ecosystem. It facilitates the management of device connectivity and data transmission between connected industrial assets and the platform. The Gateway model encompasses relationships with actual devices, account information, dataflows related to the exchange of information, and metadata for additional context or configurations. It offers a comprehensive API scope for developers to interact with these aspects, providing functionalities for associated device management, account association, and data routing, ensuring seamless data acquisition from industrial environments.Attributes
These are all attributes that can be read and updated through the API
| Name | Description | Permissions |
|---|---|---|
| id | A unique identifier for the Gateway instance, typically used as a primary key in a database. | READ ONLY |
| name | The human-readable name assigned to the gateway, often used to identify the purpose or location of the gateway. | READ AND UPDATE |
| description | A detailed explanation or commentary about the gateway's function, features, or associated services. | READ AND UPDATE |
| created_at | The timestamp indicating when the Gateway instance was initially created in the system. | READ ONLY |
| updated_at | The timestamp of the most recent modification made to the Gateway's data or configuration. | READ ONLY |
Get Gateway by ID
GEThttps://connect.autonoma.cloud/v1/resources/gateway/[ID]Returns a specific Gateway by ID.
Relations
It is possible to get related objects from Gateways.
GEThttps://connect.autonoma.cloud/v1/resources/gateway/[ID]/[RELATION]This table shows all available resources that can be queried
| Relation | Objecttype | Relationtype | |
|---|---|---|---|
| parent | Asset | 1:1 | Show details |
| account | Account | 1:1 | Show details |
| devices | Asset | many:1 | Show details |
| metadatas | Metadata | many:many | Show details |
Update Gateway
POSThttps://connect.autonoma.cloud/v1/resources/gateway/[ID]Update fields of Gateway by ID. The fields must be sent as x-www-form-urlencoded parameter.
Create Gateway
PUThttps://connect.autonoma.cloud/v1/resources/gatewayCreate a new Gateway.
Delete Gateway
DELETEhttps://connect.autonoma.cloud/v1/resources/gateway/[ID]Delete the resource Gateway by ID.
This action can not be reverted!