The following operation is the initial step to obtain the URL for connecting to the Analyzer detail view server, with a resource selected.
Execution permission
Admin, Modify
Request line
GET baseURL/v1/objects/HdcaSettings/{id}/actions/getInContextLaunchUrl
Request body
Not applicable.
Response body
The structure of the response body and the object attributes is as follows: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 HdcaInContextLaunchParam objects necessary to execute an operation. For details, see the table below. |
HdcaInContextLaunchParam
{
"resourceId":"..."
}
HdcaInContextLaunchParam (Type: HdcaInContextLaunchParam)
|
Attribute |
Type |
Description |
|---|---|---|
|
resourceId |
string |
Resource ID of In-Context Launch destination |
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/getInContextLaunchUrl 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:45:00 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 49b4df80c683e1e0abcdceeeaeec1a24559ba0fd_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]
{
"name" : "getInContextLaunchUrl",
"href" : "http://localhost:22015/Analytics/v1/objects/HdcaSettings/997104105/actions/getInContextLaunchUrl/invoke",
"method" : "POST",
"type" : "application/json",
"parameters" : [ {
"resourceId" : "resourceId"
} ]
}