5.8.4 Suggestion mapping information acquisition

Description

Gets the suggestion definition mapping information, which maps the information of the configuration management tree to the suggestion definition information.

Execution permissions

• JP1_Console_Admin

• JP1_Console_Operator

• JP1_Console_User

API version

v1

Format

Request line

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

Request message body

None.

Request message body

{
    "simtData": [
        {
            "sid": tree-SID,
            "value":{
                        "suggestionIds": [suggestion-ID,...]
                    }
            }
        },
        ...
    ]
}

Parameters

None.

Status codes

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

Status code	Message	Description
200	None	The suggestion definition mapping information was successfully acquired.
403	KAJY01000-E	The logged-in user does not have the permission to execute the REST API.

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 the acquired suggestion definition mapping information as an array. However, information of a tree SID to which no suggestion definition is mapped is not returned. When neither the jddupdatetree nor jddupdatesuggestion command is executed, an empty array is returned.
2		sid		string	Specifies the tree SID of the IM management node.
3		value		object	Additional information of the tree SID.
4			suggestionIds	string[]	An array of the suggestion IDs that are mapped to the tree SID. Even if the logged-in user is not allowed to view some suggestion definitions, the suggestion IDs corresponding to such definitions are returned.

Examples

The following example shows how to use this API:

Request:

GET http://hostname:20703/im/api/v1/nodes/treeInfo/suggestions

Response:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "simtData":[
        {"sid":"_ROOT_AllSystems/_HOST_HISOL_host1/_CATEGORY_job/_OBJECT_JP1AJSMJOB","value":{"suggestionIds":["suggestion1","suggestion2"]}},
        ...
    ]
}

To Page Top