Note The
"listServices"action both lists and describes each service.
When a valid "authToken" property is present, this action returns all information about each service.
When an "authToken" is omitted, this action returns all information except for the "tls" property.
Request examples
Retrieve service information that does not require authorization
{
"api": "admin",
"action": "listServices",
"params": {}
}Retrieve extensive service information
{
"api": "admin",
"action": "listServices",
"params": {},
"authToken": "replaceWithAuthTokenFromCreateSession"
}Retrieve extensive service information with debug information
{
"api": "admin",
"action": "listServices",
"params": {},
"requestId": "2",
"apiVersion": "1.0",
"debug": "max",
"authToken": "replaceWithAuthTokenFromCreateSession"
}
Response examples
FairCom Edge success
Note FairCom Edge has more services than FairCom DB and the
"jsonActionApiDefaults"property has different default settings.
{
"result": {
"listeners": [
{
"serviceName": "http8080",
"description": "Port 8080 using insecure HTTP protocol for REST and Web Apps on all TCP/IP addresses bound to this server",
"enabled": false,
"port": "8080",
"protocol": "http"
},
{
"serviceName": "https8443",
"description": "Port 8443 using TLS-secured HTTPS protocol for REST and Web Apps on all TCP/IP addresses bound to this server",
"enabled": true,
"port": "8443",
"protocol": "https",
"tls": {
"certificateFilename": "./web/fccert.pem"
}
},
{
"serviceName": "mqtt1883",
"description": "Port 1883 using insecure MQTT protocol for the MQTT broker on all TCP/IP addresses bound to this server",
"enabled": true,
"port": "1883",
"protocol": "mqtt"
},
{
"serviceName": "mqtts8883",
"description": "Port 8883 using TLS-secured MQTTS protocol for the MQTT broker on all TCP/IP addresses bound to this server",
"enabled": true,
"port": "8883",
"protocol": "mqtts",
"tls": {
"certificateFilename": "./web/fccert.pem"
}
},
{
"serviceName": "mqttws9001",
"description": "Port 9001 using WebSocket protocol for the MQTT broker on all TCP/IP addresses bound to this server",
"enabled": true,
"port": "9001",
"protocol": "mqttws"
},
{
"serviceName": "mqttwss9002",
"description": "Port 9002 using TLS-secured WebSocket protocol for the MQTT broker on all TCP/IP addresses bound to this server",
"enabled": true,
"port": "9002",
"protocol": "mqttwss",
"tls": {
"certificateFilename": "./web/fccert.pem"
}
},
{
"serviceName": "ISAM",
"enabled": false,
"port": "FAIRCOMS",
"protocol": "isam"
},
{
"serviceName": "SQL",
"enabled": false,
"port": "6597",
"protocol": "sql"
}
],
"jsonActionApiDefaults": {
"defaultApi": "hub",
"defaultBinaryFormat": "hex",
"defaultDatabaseName": "faircom",
"defaultDebug": "max",
"defaultOwnerName": "admin",
"defaultResponseOptions": {
"binaryFormat": "hex",
"dataFormat": "objects",
"numberFormat": "number",
"variantFormat": "json"
},
"idleConnectionTimeoutSeconds": 3600,
"idleCursorTimeoutSeconds": 600
},
"applicationRoot": "./web/apps/",
"applications": [
{
"serviceName": "Ace Monitor",
"serviceLibrary": "ctmonitor.dll",
"enabled": true,
"uriPath": "AceMonitor"
},
{
"serviceName": "Data Explorer",
"serviceLibrary": "ctsqlexplorer.dll",
"enabled": true,
"uriPath": "SQLExplorer"
},
{
"serviceName": "ISAM Explorer",
"serviceLibrary": "ctisamexplorer.dll",
"enabled": true,
"uriPath": "ISAMExplorer"
},
{
"serviceName": "Rest CRUD",
"serviceLibrary": "ctrest.dll",
"enabled": true,
"uriPath": "ctree"
},
{
"serviceName": "api",
"enabled": true,
"uriPath": "api"
}
],
"apis": [
{
"serviceName": "hub",
"enabled": true
},
{
"serviceName": "mq",
"enabled": true
},
{
"serviceName": "db",
"enabled": true
}
],
"integrationServices": [
{
"serviceName": "opcua",
"serviceLibrary": "opcservice.dll",
"enabled": true
},
{
"serviceName": "modbus",
"serviceLibrary": "modbusservice.dll",
"enabled": true
}
],
"transformServices": [
{
"serviceName": "siemensUDT2JSON",
"serviceLibrary": "siemensudtservice.dll",
"enabled": false
}
],
"otherServices": [
{
"serviceName": "dbnotify",
"serviceLibrary": "./dbnotify/fcdbnotify.dll",
"enabled": false
},
{
"serviceName": "ctagent",
"serviceLibrary": "./agent/ctagent.dll",
"enabled": false
},
{
"serviceName": "thingworx",
"serviceLibrary": "./thingworx/ctthingworx.dll",
"enabled": false
},
{
"serviceName": "aggregation",
"serviceLibrary": "./aggregation/cttimestamp.dll",
"enabled": false
},
{
"serviceName": "cthttpd",
"serviceLibrary": "./web/cthttpd.dll",
"enabled": true
}
]
},
"requestId": "00000006",
"errorCode": 0,
"errorMessage": "",
"authToken": "replaceWithAuthTokenFromCreateSession"
}Failure
{
"authToken": "invalidAuthtoken",
"debugInfo": {
"request": {
"authToken": "invalidAuthtoken",
"api": "admin",
"action": "listServices",
"params": {}
}
},
"errorCode": 12031,
"errorMessage": "'authToken' does not match any existing session. Use a valid 'authToken' or use 'createSession' to create a valid 'authToken'."
}