5.8.2 Configuration management tree information acquisition

Description

Gets tree information that is displayed in the status monitoring functionality of the Intelligent Integrated Management Base. IM management node tree information cannot be retrieved if the logged-in JP1 user has no permission to view the tree information.

Execution permissions

JP1_Console_Admin
JP1_Console_Operator
JP1_Console_User

API version

Format

Request line

GET /application/component/apiVersion/nodes/treeInfo httpVersion

Request message body

None.

Response message body

{
  "simtData ":[
     IM-management-node-tree-information-object,...
  ]
}

Parameters

None.

Status codes

The following table describes the status codes that are returned as a response to the request:

Status code	Message	Description
`200`	`OK`	The IM management node tree information was retrieved successfully.
`400`	`Bad Request`	The request header is invalid.
`401`	`Unauthorized`	Authentication is required.
`403`	`Forbidden`	There is no execution permission.
`404`	`Not Found`	The resource could not be found.
`406`	`Not Acceptable`	An invalid `Accept` or `Accept-Language` header is specified.
`412`	`Precondition failed`	The server cannot be accessed.
`415`	`Unsupported media type`	An invalid `Content-Type` header is specified.
`500`	`Internal Server Error`	An error occurred with the server processing.

Return values

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

No.	Member name	Data type	Description
1	`simtData`	object[]	Returns an array of IM management node tree information objects that contain collected IM management node tree information. A zero-length array is returned if no IM management node tree information is available. For details on the IM management node tree information object, see 7.2.2(1) IM management node tree object.

No.

Member name

Data type

Description

simtData

object[]

Returns an array of IM management node tree information objects that contain collected IM management node tree information.

A zero-length array is returned if no IM management node tree information is available.

For details on the IM management node tree information object, see 7.2.2(1) IM management node tree object.

Examples

The following example uses this API to get IM management node tree information.

Note that the value of the Authorization header must be specified in a single line.

Request:

GET /im/api/v1/nodes/treeInfo HTTP/1.1
Authorization: Bearer xxxx
Accept-Language: ja
Content-Type: application/json
Accept: application/json

Response:

HTTP/1.1 200 OK
Cache-Control: no-store, no-cache, max-age=0
Pragma: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Content-Type: application/json
 
{
    "simtData":[
        {"sid":"_ROOT_AllSystems","value":{"target":[],"label":"All Systems"}},
        {"sid":"_ROOT_AllSystems/_SYSTEM_System1","value":{"target":[],"label":"System 1",...}},
        {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1","value":{"target":[],"label":"Sub system 1",...}},
        {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1/_HOST_host1","value":{"target":[],"label":"host1",...}},
        {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1/_HOST_host1/_CATEGORY_Job","value":{"target":[],"label":"Job",...}},
        {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1/_HOST_host1/_CATEGORY_Job/_OBJECT_JP1AJSMJOB","value":{"target":[],"label":"JP1/AJS3 - Manager"}},
        {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1/_HOST_host1/_CATEGORY_Job/_OBJECT_JP1AJSMJOB/_OBJECT_ScheduleServ","value":{"target":[],"label":"ScheduleServ",...}},
        {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1/_HOST_host1/_CATEGORY_Job/_OBJECT_JP1AJSMJOB/_OBJECT_ScheduleServ/_OBJECT_jobgroup","value":{"target":[],"label":"jobgroup",...}},
         {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1/_HOST_host1/_CATEGORY_job/_OBJECT_JP1AJSMJOB/_OBJECT_ScheduleServ/_OBJECT_jobgroup/_OBJECT_jobnet1","value":{"target":[],"label":"jobnet1",...}}
    ]
}

To Page Top