WebSphere Business Monitor, Version 6.2 Operating Systems: AIX, HP-UX, Linux, Solaris, Windows


KPI - KPI Icon List Resource - GET Method

Retrieve the relative paths to all KPI icons.

Built-in icons are located at {REST_application_install_dir}/images/kpi/monitorIcons

Custom icons are located at {REST_application_install_dir}/images/kpi/customIcons

Resource URI

GET /icons/kpi

Parameters

None.

Request Content

None.

Response Content

The default content-type is application/json.

MIME Type: application/json

The following table lists all parameters in the JSON output:

Parameter Name

Type

Description

Context root

string

The context root of the REST WAR file

Icon Image Array

array

 Array of icon image relative paths (relative to REST EAR install directory)

 


+ View Schema
{ "description": "KPI Icon List", 
  "type": "object",
  "properties":
   {
	"Context Root":{"type":"string"},
   	"Icon Image Array":{
			"description": "array of KPI icon relative path", 
  			"type": ["string"]
			   }
  }
}

Example content:

{
   "Context Root":"rest/bpm/monitor",
   "Icon Image Array":[
      "images/kpi/monitorIcons/IBM_1check_blue.gif",
      "images/kpi/monitorIcons/IBM_1check_green.gif",
   ]
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{ "description": "REST error response", 
  "type": "object",
  "properties":
   { "Status Code" : {"type":"integer"},
     "Error" : {"type":"string"},
   }
} 

Status Codes

The method returns one of the following status codes:
CodeDescription
200 OK
Successful completion - requested data returned. Note that the list may be empty.
403 Forbidden
Not authorized to request the resource.
404 Not Found
Resource not found or URL not supported.
400 Bad Request
The request contains invalid parameters or is missing parameters and inputs.
500 Internal Server Error
Internal error processing the request.

Available Since

6.1

Parent Topic: KPI Icon List Resource