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


KPI - KPI Context List Resource - GET Method

Resource URI

GET /models/{model id}/versions/{version}/kcs

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

Model ID

string

The monitor model ID

Version

number

The monitor model version

KPI Context ID

string

The key performance indicator (KPI) context ID

KPI Context Name

string

The key performance indicator (KPI) context name

Diagram Exists

boolean

Flag indicating whether the diagram exists for this KPI Context. Valid values are "true" or "false"

 


+ View Schema
{ "description": "KPI Context List", 
  "type": ["object"],
  "properties":
   {
     {
       "Mode ID":{"type":"string"},
       "Version":{"type":"integer"},
       "KPI Context ID": {"type":"string"},
       "KPI Context Name":{"type":"string"},
       "Diagram Exists":{"type":"boolean"},
     }
  }
}

Example content:

{ 
  {
   "Model ID":"OrderItem"
   "Version":20060803000000
   "KPI Context ID":"FunctionKPIs" 
   "KPI Context Name":"FunctionKPIs"
   "Diagram Exists": true
  }
  { 
   "Model ID":"OrderItem"
   "Version":20060803000000
   "KPI Context ID":"TimePeriodKPIs" 
   "KPI Context Name":"TimePeriodKPIs"
   "Diagram Exists": false
  }
}

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 Context List Resource