Getting Information by Specifying Connection ID

You can get the Relay Authorization Settings information by specifying Connection ID.

Request Interface

HTTP Request

GET /relay/permission/{connectionId}

Parameter

Query Parameter	Value	Required	Description	Default Value
connectionId	string	true	Connection ID

For details on common request parameters for Site API, refer to Common Parameter.

Authorization

In the API Key Management screen in Management Console, 'Relay Auth Settings' under the 'Scopes' field must be selected as 'Get'.

Response Interface

If the request is processed successfully, the following response is returned in JSON format.

{
    "totalSize":1,
    "fetchSize":1,
    "startIndex":0,
    "maxResults":30,
    "permission":[
        {
            "connectionId":"id1",
            "remoteConnectionId":"id2",
            "direction":"send",
            "enabled":"false",
            "memo":"memo1"
        }
    ]
}

Property Name	Value	Description
totalSize	integer	The total number of data
fetchSize	integer	The number of the obtained data
startIndex	integer	Index of the first row of a data to retrieve
maxResults	integer	The maximum number of indexes included in a response data
permission	array	Array of the elements described below
connectionId	string	Connection ID
remoteConnectionId	string	Connection ID of the remote machine
direction	string	Transfer direction to enable the relay transfer
enabled	string	Whether Relay Authorization Settings are enabled or not
memo	string	Note for the settings

Examples

Java JavaScript

public static void main(String[] args) {
    String host = "https://www.webconnect.hulft.com";
    String apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
    String connectionId = "xxxxxxxx";
    try {
        URL url = new URL(host + "/api/v2/relay/permission/" + connectionId);
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();

        connection.setRequestMethod("GET");
        connection.setRequestProperty("Authorization", "Bearer " + apiKey);
        try (BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
            String line;
            while((line = reader.readLine()) != null) {
                System.out.println(line);
            }
        }
    } catch (IOException ex) {
        // error
    }
}

// load jquery 
var host = 'https://www.webconnect.hulft.com';
var apiKey = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
var connectionId = 'xxxxxxxx';
$.ajax({
  type: 'GET',
  url: host + '/api/v2/relay/permission/' + connectionId,
  headers: {
    Authorization: 'Bearer ' + apiKey
  }
}).done(function(data, status, xhr) {
  console.log(data);
}).fail(function(data, status, xhr) {
  console.log(data);
});