/testSourceEndpoint
This feature allows you to validate the endpoint connection against the effective server (for some protocols like WITSML, OPC, Modbus) behind the LiveRig Collector using the remote control API.
Required information


/testSourceEndpoint?qualifier=qualifier&instance=instance
POST
https://environment.com/services/plugin-liverig/collectors/testSourceEndpoint
Test a source endpoint. Currently supports all server mode protocols, and WITSML, Modus and WITS in client mode.
Query Parameters
Name
Type
Description
qualifier*
string
Collector qualifier
instance*
string
Collector instance
Headers
Name
Type
Description
Content-type*
string
application/json
Request Body
Name
Type
Description
source*
json
Basic information about how to connect to the source endpoint. See examples below.
{
"success": {
"result": "true"
}
}
Body examples
{
"name": "same used in collector source name",
"rigName": "same used in collector source rig name",
"serviceCompany": "same used in collector source service company",
"username": "myuser",
"password": "un%prot3ct3d",
"endpoint": "http://mywitsml.server.com",
"mode": "client", // or "server",
"protocolName": "witsml",
"protocolVersion": "1.4.1.1",
"tlsAuth": false // or true
}
Response examples
{
"success": {
"result": "true"
}
}
Last updated
Was this helpful?