API Definition
Body
operationstring · enumRequiredPossible values:
Responses
200
Updated connection
application/json
500
Failed to update the connection
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"
}
Responses
200
Array of endpoints
application/json
500
Failed to list all endpoints
get
GET /api/endpoints HTTP/1.1
Host:
Accept: */*
[
{
"id": "text",
"currentState": "enabling",
"targetState": "enabled",
"connectionId": "text",
"operation": "text",
"address": {},
"agentName": "text"
}
]
Responses
200
Sucessfully got an Endpoint
application/json
500
Failed to get endpoint
get
GET /api/endpoints/{id} HTTP/1.1
Host:
Accept: */*
{
"id": "text",
"currentState": "enabling",
"targetState": "enabled",
"connectionId": "text",
"operation": "text",
"address": {},
"agentName": "text"
}
Body
operationstring · enumRequiredPossible values:
Responses
200
Updated endpoint
application/json
500
Failed to update the endpoint
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"
}
Body
operationstring · enumRequiredPossible values:
Responses
200
Updated mapping
application/json
500
Failed to update the mapping
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"
}
Body
operationstring · enumRequiredPossible values:
Responses
200
Updated server
application/json
500
Failed to update the server
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"
}
Body
inputobject | array | string | null | number | booleanRequired
The body being inputted for transformation
transformationstringRequired
The transformation expression
Responses
200
Transformed output
application/json
Responseobject
500
Failed to transform input
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?