API Definition

Get all connection schemas

get
Responses
200
Connection schemas
application/json
Responseobject
get
GET /api/connections/schema HTTP/1.1
Host: 
Accept: */*
200

Connection schemas

{}

Get all connections

get
Responses
200
Array of connections
application/json
get
GET /api/connections HTTP/1.1
Host: 
Accept: */*
[
  {
    "id": "text",
    "currentState": "connecting",
    "targetState": "connected",
    "connection": {},
    "agentName": "text"
  }
]

Get one connection by id

get
Responses
200
Sucessfully got a connection
application/json
get
GET /api/connections/{id} HTTP/1.1
Host: 
Accept: */*
{
  "id": "text",
  "currentState": "connecting",
  "targetState": "connected",
  "connection": {},
  "agentName": "text"
}

Update an existing connection

put
Body
operationstring · enumRequiredPossible values:
Responses
200
Updated connection
application/json
put
PUT /api/connections/{id}/operation HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "operation": "connect"
}
{
  "id": "text",
  "currentState": "connecting",
  "targetState": "connected",
  "connection": {},
  "agentName": "text"
}

Get all endpoint schemas

get
Responses
200
Endpoint schemas
application/json
Responseobject
get
GET /api/endpoints/schema HTTP/1.1
Host: 
Accept: */*
200

Endpoint schemas

{}

Get all endpoints

get
Responses
200
Array of endpoints
application/json
get
GET /api/endpoints HTTP/1.1
Host: 
Accept: */*
[
  {
    "id": "text",
    "currentState": "enabling",
    "targetState": "enabled",
    "connectionId": "text",
    "operation": "text",
    "address": {},
    "agentName": "text"
  }
]

Get one endpoint by id

get
Responses
200
Sucessfully got an Endpoint
application/json
get
GET /api/endpoints/{id} HTTP/1.1
Host: 
Accept: */*
{
  "id": "text",
  "currentState": "enabling",
  "targetState": "enabled",
  "connectionId": "text",
  "operation": "text",
  "address": {},
  "agentName": "text"
}

Get one endpoint topics by id

get
Responses
200
Sucessfully got an Endpoint topics
application/json
Responsestring[]
get
GET /api/endpoints/{id}/topics HTTP/1.1
Host: 
Accept: */*
[
  "text"
]

Get one endpoint state by id

get
Responses
200
Sucessfully got an Endpoint state
application/json
Responsestring
get
GET /api/endpoints/{id}/state HTTP/1.1
Host: 
Accept: */*
text

Update an existing endpoint

put
Body
operationstring · enumRequiredPossible values:
Responses
200
Updated endpoint
application/json
put
PUT /api/endpoints/{id}/operation HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "operation": "enable"
}
{
  "id": "text",
  "currentState": "enabling",
  "targetState": "enabled",
  "connectionId": "text",
  "operation": "text",
  "address": {},
  "agentName": "text"
}

Get all mapping schemas

get
Responses
200
Mapping schemas
application/json
Responseobject
get
GET /api/mappings/schema HTTP/1.1
Host: 
Accept: */*
200

Mapping schemas

{}

Get all mappings

get
Responses
200
Array of mappings
application/json
get
GET /api/mappings HTTP/1.1
Host: 
Accept: */*
[
  {
    "id": "text",
    "currentState": "enabling",
    "targetState": "enabled",
    "mappings": [
      {}
    ],
    "agentName": "text"
  }
]

Get one mapping by id

get
Responses
200
Sucessfully got an Mapping
application/json
get
GET /api/mappings/{id} HTTP/1.1
Host: 
Accept: */*
{
  "id": "text",
  "currentState": "enabling",
  "targetState": "enabled",
  "mappings": [
    {}
  ],
  "agentName": "text"
}

Update an existing mapping

put
Body
operationstring · enumRequiredPossible values:
Responses
200
Updated mapping
application/json
put
PUT /api/mappings/{id}/operation HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "operation": "enable"
}
{
  "id": "text",
  "currentState": "enabling",
  "targetState": "enabled",
  "mappings": [
    {}
  ],
  "agentName": "text"
}

Get endpoint topics for a given mapping

get
Responses
200
Sucessfully got the Mapping endpoint topics
application/json
get
GET /api/mappings/{id}/endpoint-topics HTTP/1.1
Host: 
Accept: */*
{
  "ANY_ADDITIONAL_PROPERTY": [
    "text"
  ]
}

Get one mapping state by id

get
Responses
200
Sucessfully got an Mapping state
application/json
Responsestring
get
GET /api/mappings/{id}/state HTTP/1.1
Host: 
Accept: */*
text

Get all server schemas

get
Responses
200
Server schemas
application/json
Responseobject
get
GET /api/servers/schema HTTP/1.1
Host: 
Accept: */*
200

Server schemas

{}

Get all servers

get
Responses
200
Array of servers
application/json
get
GET /api/servers HTTP/1.1
Host: 
Accept: */*
[
  {
    "id": "text",
    "options": {},
    "currentState": "enabling",
    "targetState": "enabled",
    "protocol": "Opcua",
    "agentName": "text"
  }
]

Get one server by id

get
Responses
200
Sucessfully got a Server
application/json
get
GET /api/servers/{id} HTTP/1.1
Host: 
Accept: */*
{
  "id": "text",
  "options": {},
  "currentState": "enabling",
  "targetState": "enabled",
  "protocol": "Opcua",
  "agentName": "text"
}

Update an existing servers

put
Body
operationstring · enumRequiredPossible values:
Responses
200
Updated server
application/json
put
PUT /api/servers/{id}/operation HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "operation": "enable"
}
{
  "id": "text",
  "options": {},
  "currentState": "enabling",
  "targetState": "enabled",
  "protocol": "Opcua",
  "agentName": "text"
}

Get one server state by id

get
Responses
200
Sucessfully got a Server state
application/json
Responsestring
get
GET /api/servers/{id}/state HTTP/1.1
Host: 
Accept: */*
text

Get all nodes

get
Responses
200
Array of nodes
application/json
get
GET /api/nodes HTTP/1.1
Host: 
Accept: */*
[
  {
    "id": "text",
    "currentState": "enabling",
    "targetState": "enabled",
    "nodes": [
      {}
    ],
    "agentName": "text"
  }
]

Get one node state by id

get
Responses
200
Sucessfully got an Node state
application/json
Responsestring
get
GET /api/nodes/{id}/state HTTP/1.1
Host: 
Accept: */*
text

Get all available topics

get
Responses
200
Topics organized by their associated resources
application/json
get
GET /api/topics HTTP/1.1
Host: 
Accept: */*
{
  "endpoints": [
    {}
  ],
  "mappings": [
    {}
  ],
  "nodes": [
    {}
  ]
}

Execute rule engine transformation

post
Body
inputobject | array | string | null | number | booleanRequired

The body being inputted for transformation

transformationstringRequired

The transformation expression

Responses
200
Transformed output
application/json
Responseobject
post
POST /api/rule-engine/transform HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "input": null,
  "transformation": "text"
}
{}

Last updated

Was this helpful?