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


KPI - KPI Definition Resource - GET Method

Retrieve the structure of an existing KPI by model ID and version.

Resource URI

GET /models/{model id}/versions/{version}/kpis/config/{kpi id}?{parameters}

Parameters

Optional Parameters
NameValue TypeDescription
locale string
The locale. This value consists of lowercase ISO language code (ISO 639) and the uppercase ISO country code (ISO 3166) joined by an underscore (for example, en_US). Results will be returned in the locale specified. If no locale is specified, the locale of the REST server will be used.

Request Content

None.

Response Content

Every Target, Range Start/End and KPI Value is localized into a decimal or duration according to locale and KPI data type before being returned to the client.

The GET request type will return the same output as "KPI Definition with Value" except no KPI Value or KPI Value Localized is returned. For more information on the output parameters, see Retrieve KPI definition with a value.

The default content-type is application/json.

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 Definition Resource