5.10.1 URL information acquisition

Description

Gets the URL to start the monitor window of a linked product that corresponds to the SID of the specified IM management node. Executing this API returns the URL via the __urlGet method of the user-created plug-in.

For details on the __urlGet method, see 4.4.4(8) __urlGet method.

Execution permissions

JP1_Console_Admin
JP1_Console_Operator
JP1_Console_User

API version

Format

Request line

POST /application/component/apiVersion/nodes/monitorUrl httpVersion

Request message body

{
    "sid": IM-management-node-SID
}

Response message body

{
    urlList:[
    {
      "url": URL-for-starting-the-monitor,
      "name": display-name-of-the-URL
    },
    ...
    ]
}

Parameters

sid: Specifies the SID (management object ID). This parameter cannot be omitted.

Status codes

Status code	Message	Description
200	None	Processing of the URL information acquisition REST API was successful.
400	KAJY02049-E	The URL information acquisition REST API cannot be executed due to an invalid parameter of the URL information acquisition REST API.
400	KAJY22011-E	A nonexistent SID has been specified.
403	KAJY01000-E	There is no permission to run the REST API.
500	KAJY02050-E	An attempt to obtain the URL failed.

Return values

The following information is returned in the response body if the status code is 200:

No.	Member name	Data type	Description
1	`urlList`	object[]	The obtained URL information is returned as an array. If the URL that corresponds to the specified SID does not exist, an array with 0 elements is returned.
2	`url`	string	Specifies the URL for starting the linked product.
3	`name`	string	Specifies the display name of the URL.

Examples

The following shows a usage example of the API to get the URL for starting the monitor of a jobnet (sid:_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_schedulerserv/_JP1JOBG_jobgroup/_JP1ROOTJOBNET_jobnet1) that is a management object.

Request:

POST http://hostname:20703/im/api/v1/nodes/monitorUrl
{
"sid":"_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_schedulerserv/_JP1JOBG_jobgroup/_JP1ROOTJOBNET_jobnet1"
}

Response:

{
  urlList:[
    {
      "url":"http://xxx.xxx.xxx.xxx:22252/ajs/...",
      "name":"JP1/AJS3 - Web Console (List)"
    }
  ]
}

To Page Top