Industry Protocol Details (API)

20KB

Protocol Mapper Schema.yaml

Get all connection schemas

GET/api/connections/schema

Response

200

Connection schemas

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/connections/schema', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get all connections

GET/api/connections

Response

200500

Array of connections

Body

application/json

id*string

currentState*enum

connectingconnecteddisconnectingdisconnected

targetState*enum

connecteddisconnected

connection*object

agentName*string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/connections', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "currentState": "connecting",
    "targetState": "connected",
    "agentName": "text"
  }
]

Get one connection by id

GET/api/connections/{id}

Response

200500

Sucessfully got a connection

Body

application/json

id*string

currentState*enum

connectingconnecteddisconnectingdisconnected

targetState*enum

connecteddisconnected

connection*object

agentName*string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/connections/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Update an existing connection

PUT/api/connections/{id}/operation

Body

application/json

Operation to perform on the connection

operation*enum

connectdisconnect

Response

200500

Updated connection

Body

application/json

id*string

currentState*enum

connectingconnecteddisconnectingdisconnected

targetState*enum

connecteddisconnected

connection*object

agentName*string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/connections/{id}/operation', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "operation": "connect"
    }),
});
const data = await response.json();

Response

200

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

Get all endpoint schemas

GET/api/endpoints/schema

Response

200

Endpoint schemas

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/endpoints/schema', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get all endpoints

GET/api/endpoints

Response

200500

Array of endpoints

Body

application/json

id*string

currentState*enum

enablingenableddisablingdisabled

targetState*enum

enableddisabled

connectionId*string

operation*string

address*object

agentName*string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/endpoints', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Get one endpoint by id

GET/api/endpoints/{id}

Response

200500

Sucessfully got an Endpoint

Body

application/json

id*string

currentState*enum

enablingenableddisablingdisabled

targetState*enum

enableddisabled

connectionId*string

operation*string

address*object

agentName*string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/endpoints/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Get one endpoint topics by id

GET/api/endpoints/{id}/topics

Response

200500

Sucessfully got an Endpoint topics

Body

application/json

itemsstring

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/endpoints/{id}/topics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  "text"
]

Get one endpoint state by id

GET/api/endpoints/{id}/state

Response

200500

Sucessfully got an Endpoint state

Body

application/json

string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/endpoints/{id}/state', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

Update an existing endpoint

PUT/api/endpoints/{id}/operation

Body

application/json

Operation to perform on the endpoint

operation*enum

enabledisable

Response

200500

Updated endpoint

Body

application/json

id*string

currentState*enum

enablingenableddisablingdisabled

targetState*enum

enableddisabled

connectionId*string

operation*string

address*object

agentName*string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/endpoints/{id}/operation', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "operation": "enable"
    }),
});
const data = await response.json();

Response

200

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

Get all mapping schemas

GET/api/mappings/schema

Response

200

Mapping schemas

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/mappings/schema', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get all mappings

GET/api/mappings

Response

200500

Array of mappings

Body

application/json

idstring

currentStateenum

enablingenableddisablingdisabled

targetStateenum

enableddisabled

mappingsarray of object

agentNamestring

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/mappings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Get one mapping by id

GET/api/mappings/{id}

Response

200500

Sucessfully got an Mapping

Body

application/json

idstring

currentStateenum

enablingenableddisablingdisabled

targetStateenum

enableddisabled

mappingsarray of object

agentNamestring

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/mappings/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Update an existing mapping

PUT/api/mappings/{id}/operation

Body

application/json

Operation to perform on the mapping

operation*enum

enabledisable

Response

200500

Updated mapping

Body

application/json

idstring

currentStateenum

enablingenableddisablingdisabled

targetStateenum

enableddisabled

mappingsarray of object

agentNamestring

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/mappings/{id}/operation', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "operation": "enable"
    }),
});
const data = await response.json();

Response

200

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

Get endpoint topics for a given mapping

GET/api/mappings/{id}/endpoint-topics

Response

200500

Sucessfully got the Mapping endpoint topics

Body

application/json

Other propertiesarray of string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/mappings/{id}/endpoint-topics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get one mapping state by id

GET/api/mappings/{id}/state

Response

200500

Sucessfully got an Mapping state

Body

application/json

string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/mappings/{id}/state', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

Get all server schemas

GET/api/servers/schema

Response

200

Server schemas

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/servers/schema', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get all servers

GET/api/servers

Response

200500

Array of servers

Body

application/json

id*string

options*object

currentState*enum

enablingenableddisablingdisabled

targetState*enum

enableddisabled

protocol*enum

OpcuaHttp

agentName*string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/servers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "currentState": "enabling",
    "targetState": "enabled",
    "protocol": "Opcua",
    "agentName": "text"
  }
]

Get one server by id

GET/api/servers/{id}

Response

200404500

Sucessfully got a Server

Body

application/json

id*string

options*object

currentState*enum

enablingenableddisablingdisabled

targetState*enum

enableddisabled

protocol*enum

OpcuaHttp

agentName*string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/servers/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Update an existing servers

PUT/api/servers/{id}/operation

Body

application/json

Operation to perform on the server

operation*enum

enabledisable

Response

200500

Updated server

Body

application/json

id*string

options*object

currentState*enum

enablingenableddisablingdisabled

targetState*enum

enableddisabled

protocol*enum

OpcuaHttp

agentName*string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/servers/{id}/operation', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "operation": "enable"
    }),
});
const data = await response.json();

Response

200

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

Get one server state by id

GET/api/servers/{id}/state

Response

200500

Sucessfully got a Server state

Body

application/json

string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/servers/{id}/state', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

Get all nodes

GET/api/nodes

Response

200500

Array of nodes

Body

application/json

idstring

currentStateenum

enablingenableddisablingdisabled

targetStateenum

enableddisabled

nodesarray of object

agentNamestring

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/nodes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "currentState": "enabling",
    "targetState": "enabled",
    "nodes": [],
    "agentName": "text"
  }
]

Get one node state by id

GET/api/nodes/{id}/state

Response

200500

Sucessfully got an Node state

Body

application/json

string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/nodes/{id}/state', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

Get all available topics

GET/api/topics

Response

200500

Topics organized by their associated resources

Body

application/json

endpointsarray of object

mappingsarray of object

nodesarray of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/topics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "endpoints": [],
  "mappings": [],
  "nodes": []
}

Execute rule engine transformation

POST/api/rule-engine/transform

Body

application/json

input*nullable one of

The body being inputted for transformation

objectarray of anystringnumberboolean

transformation*string

The transformation expression

Response

200500

Transformed output

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/rule-engine/transform', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "transformation": "text"
    }),
});
const data = await response.json();