Getting the URL of the Analyzer detail view server

Ops Center Analyzer REST API Reference Guide

Version
11.0.x
Audience
anonymous
Part Number
MK-99ANA003-18

You can obtain the URL for connecting to the Analyzer detail view server, with a resource selected.

Execution permission

Admin, Modify

Request line

POST baseURL/v1/objects/HdcaSettings/{id}/actions/getInContextLaunchUrl/invoke

Request body

The structure of the request body and the object attributes are 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

Response body

The structure of the response body and the object attributes is as follows:

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

ID of the Instance.

created

string

Date the object is generated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).

updated

string

Time the object is updated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).

completed

string

Time the processing completed in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).

state

string

One of the following values is set:

"failed": The operation failed.

"success": The operation completed successfully.

affectedResource

string[]

A blank space is set.

result

anyType[]

A list of HdcaInContextLaunchUrl objects. For details, see the table below.

HdcaInContextLaunchUrl

{
        "inContextLaunchUrl":"..."
}

HdcaInContextLaunchUrl (Type: HdcaInContextLaunchUrl)

Attribute

Type

Description

inContextLaunchUrl

string

URL 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]
POST /Analytics/v1/objects/HdcaSettings/997104105/actions/getInContextLaunchUrl/invoke
Host: localhost:22015
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.49.1
Accept: application/json
Content-Type:application/json

[Request Body]
{
  "name" : "getInContextLaunchUrl",
  "href" : "http://localhost:22015/Analytics/v1/objects/HdcaSettings/1243417192/actions/getInContextLaunchUrl/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters": [
    {
      "resourceId": "raidLdev#51547-00^00^00"
    }
  ]
}

[Response Header]
HTTP/1.1 200 OK
Cache-Control: no-cache
Connection: Keep-Alive
Content-Type: application/json
Date: Tue, 24 Jan 2017 01:20:00 GMT
Server: Cosminexus HTTP Server
Transfer-Encoding: chunked
WWW-Authenticate: HSSO c450462eec01893d4c1ebcba7e7876538bd94_VwBvNGpyDgxyCUY3eXZdCQ==_V0810
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-XSS-Protection : 1; mode=block


[Response Body]
{
  "instanceID": "685ca5af-1ee3-4168-8873-f9ed5bebc431",
  "created": "2017-01-24T11:20:28.364+09:00",
  "updated": "2017-01-24T11:20:28.364+09:00",
  "completed": "2017-01-24T11:20:28.364+09:00",
  "state": "success",
  "affectedResource": [],
  "result": [
    {
      "inContextLaunchUrl": "https://172.17.25.104:8443/launchApp.htm?launchId=4ecb6a91-b500-426d-9212-17bb173123e7&resSig=cmFpZExkZXYjNTE1NDctMDBeMDBeMDA="
    }
  ]
}