Industry Protocol Details (API)

Protocol Mapper Schema.yaml

20KB

Open

Get all connection schemas

get

Authorizations

Responses

200

Connection schemas

application/json

objectOptional

get/connections/schema

GET /api/connections/schema HTTP/1.1
Accept: */*

200

Connection schemas

{}

Get all connections

get

Authorizations

Responses

200

Array of connections

application/json

idstringRequired

currentStatestring · enumRequiredPossible values:

targetStatestring · enumRequiredPossible values:

connectionobjectRequired

agentNamestringRequired

500

Failed to list all connections

get/connections

GET /api/connections HTTP/1.1
Accept: */*

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

Get one connection by id

get

Authorizations

Responses

200

Sucessfully got a connection

application/json

idstringRequired

currentStatestring · enumRequiredPossible values:

targetStatestring · enumRequiredPossible values:

connectionobjectRequired

agentNamestringRequired

500

Failed to get connection

get/connections/{id}

GET /api/connections/{id} HTTP/1.1
Accept: */*

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

Update an existing connection

put

Authorizations

Body

operationstring · enumRequiredPossible values:

Responses

200

Updated connection

application/json

idstringRequired

currentStatestring · enumRequiredPossible values:

targetStatestring · enumRequiredPossible values:

connectionobjectRequired

agentNamestringRequired

500

Failed to update the connection

put/connections/{id}/operation

PUT /api/connections/{id}/operation HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "operation": "connect"
}

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

Get all endpoint schemas

get

Authorizations

Responses

200

Endpoint schemas

application/json

objectOptional

get/endpoints/schema

GET /api/endpoints/schema HTTP/1.1
Accept: */*

200

Endpoint schemas

{}

Get all endpoints

get

Authorizations

Responses

200

Array of endpoints

application/json

idstringRequired

currentStatestring · enumRequiredPossible values:

targetStatestring · enumRequiredPossible values:

connectionIdstringRequired

operationstringRequired

addressobjectRequired

agentNamestringRequired

500

Failed to list all endpoints

get/endpoints

GET /api/endpoints HTTP/1.1
Accept: */*

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

Get one endpoint by id

get

Authorizations

Responses

200

Sucessfully got an Endpoint

application/json

idstringRequired

currentStatestring · enumRequiredPossible values:

targetStatestring · enumRequiredPossible values:

connectionIdstringRequired

operationstringRequired

addressobjectRequired

agentNamestringRequired

500

Failed to get endpoint

get/endpoints/{id}

GET /api/endpoints/{id} HTTP/1.1
Accept: */*

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

Get one endpoint topics by id

get

Authorizations

Responses

200

Sucessfully got an Endpoint topics

application/json

string[]Optional

500

Failed to get endpoint topics

get/endpoints/{id}/topics

GET /api/endpoints/{id}/topics HTTP/1.1
Accept: */*

[
  "text"
]

Get one endpoint state by id

get

Authorizations

Responses

200

Sucessfully got an Endpoint state

application/json

stringOptional

500

Failed to get endpoint state

get/endpoints/{id}/state

GET /api/endpoints/{id}/state HTTP/1.1
Accept: */*

text

Update an existing endpoint

put

Authorizations

Body

operationstring · enumRequiredPossible values:

Responses

200

Updated endpoint

application/json

idstringRequired

currentStatestring · enumRequiredPossible values:

targetStatestring · enumRequiredPossible values:

connectionIdstringRequired

operationstringRequired

addressobjectRequired

agentNamestringRequired

500

Failed to update the endpoint

put/endpoints/{id}/operation

PUT /api/endpoints/{id}/operation HTTP/1.1
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

Authorizations

Responses

200

Mapping schemas

application/json

objectOptional

get/mappings/schema

GET /api/mappings/schema HTTP/1.1
Accept: */*

200

Mapping schemas

{}

Get all mappings

get

Authorizations

Responses

200

Array of mappings

application/json

idstringOptional

currentStatestring · enumOptionalPossible values:

targetStatestring · enumOptionalPossible values:

mappingsobject[]Optional

agentNamestringOptional

500

Failed to list all mappings

get/mappings

GET /api/mappings HTTP/1.1
Accept: */*

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

Get one mapping by id

get

Authorizations

Responses

200

Sucessfully got an Mapping

application/json

idstringOptional

currentStatestring · enumOptionalPossible values:

targetStatestring · enumOptionalPossible values:

mappingsobject[]Optional

agentNamestringOptional

500

Failed to get mapping

get/mappings/{id}

GET /api/mappings/{id} HTTP/1.1
Accept: */*

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

Update an existing mapping

put

Authorizations

Body

operationstring · enumRequiredPossible values:

Responses

200

Updated mapping

application/json

idstringOptional

currentStatestring · enumOptionalPossible values:

targetStatestring · enumOptionalPossible values:

mappingsobject[]Optional

agentNamestringOptional

500

Failed to update the mapping

put/mappings/{id}/operation

PUT /api/mappings/{id}/operation HTTP/1.1
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

Authorizations

Responses

200

Sucessfully got the Mapping endpoint topics

application/json

Other propertiesstring[]Optional

500

Failed to get mapping endpoint topics

get/mappings/{id}/endpoint-topics

GET /api/mappings/{id}/endpoint-topics HTTP/1.1
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": [
    "text"
  ]
}

Get one mapping state by id

get

Authorizations

Responses

200

Sucessfully got an Mapping state

application/json

stringOptional

500

Failed to get mapping state

get/mappings/{id}/state

GET /api/mappings/{id}/state HTTP/1.1
Accept: */*

text

Get all server schemas

get

Authorizations

Responses

200

Server schemas

application/json

objectOptional

get/servers/schema

GET /api/servers/schema HTTP/1.1
Accept: */*

200

Server schemas

{}

Get all servers

get

Authorizations

Responses

200

Array of servers

application/json

idstringRequired

optionsobjectRequired

currentStatestring · enumRequiredPossible values:

targetStatestring · enumRequiredPossible values:

protocolstring · enumRequiredPossible values:

agentNamestringRequired

500

Failed to list all servers

get/servers

GET /api/servers HTTP/1.1
Accept: */*

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

Get one server by id

get

Authorizations

Responses

200

Sucessfully got a Server

application/json

idstringRequired

optionsobjectRequired

currentStatestring · enumRequiredPossible values:

targetStatestring · enumRequiredPossible values:

protocolstring · enumRequiredPossible values:

agentNamestringRequired

404

Server not found

500

Failed to get server

get/servers/{id}

GET /api/servers/{id} HTTP/1.1
Accept: */*

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

Update an existing servers

put

Authorizations

Body

operationstring · enumRequiredPossible values:

Responses

200

Updated server

application/json

idstringRequired

optionsobjectRequired

currentStatestring · enumRequiredPossible values:

targetStatestring · enumRequiredPossible values:

protocolstring · enumRequiredPossible values:

agentNamestringRequired

500

Failed to update the server

put/servers/{id}/operation

PUT /api/servers/{id}/operation HTTP/1.1
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

Authorizations

Responses

200

Sucessfully got a Server state

application/json

stringOptional

500

Failed to get server state

get/servers/{id}/state

GET /api/servers/{id}/state HTTP/1.1
Accept: */*

text

Get all nodes

get

Authorizations

Responses

200

Array of nodes

application/json

idstringOptional

currentStatestring · enumOptionalPossible values:

targetStatestring · enumOptionalPossible values:

nodesobject[]Optional

agentNamestringOptional

500

Failed to list all nodes

get/nodes

GET /api/nodes HTTP/1.1
Accept: */*

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

Get one node state by id

get

Authorizations

Responses

200

Sucessfully got an Node state

application/json

stringOptional

500

Failed to get node state

get/nodes/{id}/state

GET /api/nodes/{id}/state HTTP/1.1
Accept: */*

text

Get all available topics

get

Authorizations

Responses

200

Topics organized by their associated resources

application/json

endpointsobject[]Optional

mappingsobject[]Optional

nodesobject[]Optional

500

Failed to list all available topics

get/topics

GET /api/topics HTTP/1.1
Accept: */*

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

Execute rule engine transformation

post

Authorizations

Body

inputobject | array | string | number | boolean · nullableRequired

The body being inputted for transformation

transformationstringRequired

The transformation expression

Responses

200

Transformed output

application/json

objectOptional

500

Failed to transform input

post/rule-engine/transform

POST /api/rule-engine/transform HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 38

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

{}