You can obtain a list of operations that can be performed on a specific connection setting for the Analyzer detail view server.
Execution permission
Admin, Modify
Request line
GET baseURL/v1/objects/HdcaSettings/{id}/actions
Request body
Not applicable.
Response body
The structure of the response body and the object attributes is as follows:Collections
{
"data":["...", ...],
"pagination":{
"page":"...",
"pageSize":"...",
"numPages":"...",
"totalCount":"..."
},
"count":"..."
}
Collections (Type: Collections)
|
Attribute |
Type |
Description |
|---|---|---|
|
data |
anyType[] |
A list of Action objects. For details, see the table below. |
|
pagination |
Pagination |
Page information. This parameter is displayed only when the relevant resource exists. |
|
count |
int |
Number of data items that meet the conditions related to this query(API). |
pagination (Type: Pagination)
|
Attribute |
Type |
Description |
|---|---|---|
|
page |
integer |
Page. |
|
pageSize |
integer |
Size of page. |
|
numPages |
integer |
Number of pages. |
|
totalCount |
integer |
Number of objects. |
Action
{
"name":"...",
"href":"...",
"method":"...",
"type":"...",
"parameters":["...", ...]
}
Action (Type: Action)
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
string |
Name of the action. |
|
href |
string |
URL for the action. |
|
method |
string |
Name of the method. |
|
type |
string |
Data format for the object. |
|
parameters |
anyType[] |
A list of objects necessary to execute an operation. No value is set. |
Status codes
|
Status code |
Reason phrase |
Description |
|---|---|---|
|
200 |
OK |
Success. |
|
400 |
Bad Request |
The format of the request body is invalid. |
|
401 |
Unauthorized |
No login privilege. |
|
403 |
Forbidden |
No execute privilege. |
|
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/actions HTTP/1.1
Host: localhost:22015
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.49.1
Accept: application/json
Content-Type:application/json
[Response Header]
HTTP/1.1 200 OK
Date: Tue, 31 Jan 2017 04:44:26 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 8a2e74abf3032bec56e82d2f424d7874b77e2_ZAlDR1YdfRBWBxNW_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]
{
"data" : [ {
"name" : "getInContextLaunchUrl",
"href" : "http://localhost:22015/Analytics/v1/objects/HdcaSettings/997104105/actions/getInContextLaunchUrl/invoke",
"method" : "POST",
"type" : "application/json",
"parameters" : [ ]
} ],
"count" : 1
}