You can obtain information about a specific connection setting for the Analyzer detail view server, such as the host name and user name.
Execution permission
Admin, Modify
Request line
GET baseURL/v1/objects/HdcaSettings/{id}
Request body
Not applicable.
Response body
The structure of the response body and the object attributes is as follows:HdcaSetting
{
"instanceID":"...",
"host":"...",
"protocol":"...",
"port":"...",
"userName":"...",
"connectionResult":"...",
"url":"...",
"message":"...",
"messageID":"..."
}
HdcaSetting (Type: HdcaSetting)
|
Attribute |
Type |
Description |
|---|---|---|
|
instanceID |
string |
ID of the connection setting. |
|
host |
string |
Host name used for connecting to the Analyzer detail view server. |
|
protocol |
string |
Protocol used for connecting to the Analyzer detail view server. |
|
port |
int |
Port number used for connecting to the Analyzer detail view server. |
|
userName |
string |
Administration user of Analyzer detail view. |
|
connectionResult |
boolean |
Whether or not connection to the Analyzer detail view server was successful. |
|
url |
string |
URL of the Analyzer detail view server. |
|
message |
string |
The error message when connection failed. |
|
messageID |
string |
ID of the error message when connection failed. |
Status codes
|
Status code |
Reason phrase |
Description |
|---|---|---|
|
200 |
OK |
Success. |
|
401 |
Unauthorized |
No login privilege. |
|
404 |
Not Found |
The resource was not found. |
|
412 |
Precondition Failed |
The server is not available. |
|
500 |
Internal Server Error |
Server processing error. |
Example code
[Request Header]
GET /Analytics/v1/objects/HdcaSettings/997104105
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json
[Response Header]
HTTP/1.1 200 OK
Date: Thu, 11 Aug 2016 17:56:36 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 8113b75377dac59b7c48ee2b947b20d3bbc11f_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json
[Response Body]
{
"instanceID" : "997104105",
"host" : "172.17.25.153",
"protocol" : "https",
"port" : 8443,
"userName" : "admin",
"connectionResult" : false,
"url" : "https://172.17.25.153:8443/launchApp.htm?launchId=a1341d12-8288-4173-b806-2d8861a896d1"
}