/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

Identifying the Liverig integration qualifier

Identifying the additional collector source details for WITSML protocol

Please note that it is necessary to replace the term "environment" with the correct address before using the API.

/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.

200 Returns an object with the property "success" as the WITSML response status. See details 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

Ok

{
    "success": {
        "result": "true"
    }
}

Warning

{
    "success": {
        "result": "false",
        "exception": "javax.xml.ws.WebServiceException",
        "message": "Unsupported endpoint address: asd1"
    }
}

Error

{
    "failure": "error message string"
}