Last updated 8 months ago
Was this helpful?
GET /api/connections/schema HTTP/1.1 Host: Accept: */*
Connection schemas
{}
GET /api/connections HTTP/1.1 Host: Accept: */*
Array of connections
[ { "id": "text", "currentState": "connecting", "targetState": "connected", "connection": {} } ]
GET /api/connections/{id} HTTP/1.1 Host: Accept: */*
Sucessfully got a connection
{ "id": "text", "currentState": "connecting", "targetState": "connected", "connection": {} }
GET /api/endpoints/schema HTTP/1.1 Host: Accept: */*
Endpoint schemas
GET /api/endpoints HTTP/1.1 Host: Accept: */*
Array of endpoints
[ { "id": "text", "currentState": "enabling", "targetState": "enabled", "connectionId": "text", "operation": "text", "address": {} } ]
GET /api/endpoints/{id} HTTP/1.1 Host: Accept: */*
Sucessfully got an Endpoint
{ "id": "text", "currentState": "enabling", "targetState": "enabled", "connectionId": "text", "operation": "text", "address": {} }
GET /api/endpoints/{id}/topics HTTP/1.1 Host: Accept: */*
Sucessfully got an Endpoint topics
[ "text" ]
GET /api/endpoints/{id}/state HTTP/1.1 Host: Accept: */*
Sucessfully got an Endpoint state
text
GET /api/mappings/schema HTTP/1.1 Host: Accept: */*
Mapping schemas
GET /api/mappings HTTP/1.1 Host: Accept: */*
Array of mappings
[ { "id": "text", "currentState": "enabling", "targetState": "enabled", "mappings": [ {} ] } ]
GET /api/mappings/{id} HTTP/1.1 Host: Accept: */*
Sucessfully got an Mapping
{ "id": "text", "currentState": "enabling", "targetState": "enabled", "mappings": [ {} ] }
GET /api/mappings/{id}/endpoint-topics HTTP/1.1 Host: Accept: */*
Sucessfully got the Mapping endpoint topics
{ "ANY_ADDITIONAL_PROPERTY": [ "text" ] }
GET /api/mappings/{id}/state HTTP/1.1 Host: Accept: */*
Sucessfully got an Mapping state
GET /api/servers/schema HTTP/1.1 Host: Accept: */*
Server schemas
GET /api/servers HTTP/1.1 Host: Accept: */*
Array of servers
[ { "id": "text", "options": {}, "currentState": "enabling", "targetState": "enabled", "protocol": "Opcua" } ]
GET /api/servers/{id} HTTP/1.1 Host: Accept: */*
Sucessfully got a Server
{ "id": "text", "options": {}, "currentState": "enabling", "targetState": "enabled", "protocol": "Opcua" }
GET /api/servers/{id}/state HTTP/1.1 Host: Accept: */*
Sucessfully got a Server state
GET /api/nodes HTTP/1.1 Host: Accept: */*
Array of nodes
[ { "id": "text", "currentState": "enabling", "targetState": "enabled", "nodes": [ {} ] } ]
GET /api/nodes/{id}/state HTTP/1.1 Host: Accept: */*
Sucessfully got an Node state
GET /api/topics HTTP/1.1 Host: Accept: */*
Topics organized by their associated resources
{ "endpoints": [ {} ], "mappings": [ {} ], "nodes": [ {} ] }
connect
disconnect
PUT /api/connections/{id}/operation HTTP/1.1 Host: Content-Type: application/json Accept: */* Content-Length: 23 { "operation": "connect" }
Updated connection
enable
disable
PUT /api/endpoints/{id}/operation HTTP/1.1 Host: Content-Type: application/json Accept: */* Content-Length: 22 { "operation": "enable" }
Updated endpoint
PUT /api/mappings/{id}/operation HTTP/1.1 Host: Content-Type: application/json Accept: */* Content-Length: 22 { "operation": "enable" }
Updated mapping
PUT /api/servers/{id}/operation HTTP/1.1 Host: Content-Type: application/json Accept: */* Content-Length: 22 { "operation": "enable" }
Updated server
The body being inputted for transformation
The transformation expression
POST /api/rule-engine/transform HTTP/1.1 Host: Content-Type: application/json Accept: */* Content-Length: 54 { "input": {}, "transformation": { "output": {}, "error": {} } }
Transformed output
