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


Model - Versioned Monitoring Context Metrics Resource - GET Method

Resource URI

GET /models/{model id}/versions/{version}/mcs/{mc id}/metrics

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

integer

The monitor model version

MCID

string

The monitoring context ID

Metric Array

array

 

 

Metric ID

string

The metric ID

 

Metric Name

string

The metric display name

 

Metric Type

string

The metric data type. Valid values are "STRING", "BOOLEAN", "DECIMAL", "INTEGER", "DATE", "TIME", "DATETIME", "DURATION", 'COUNTER", "STOPWATCH-A", and "STOPWATCH-NA"

 

Metric Sortable

string

Whether the metric is indexed for sorting. Valid values are "true" or "false"

 


+ View Schema
{ "description": "Version-Specific Metric List", 
  "type": "object",
  "properties":
	{   "Model ID":{"type":"string"},
	    "Version":{"type":"integer"},
	    "MCID":{"type":"string"},
	    "Metric Array": [
		"Metric ID":{"type":"string"},
		"Metric Name":{"type":"string"},
		"Metric Sortable":{"type":"string"},
		"Metric Type":{"type":"string"},
			]
	}
}

Example content:

{
  "Model ID":"OrderItem",
  "Version":20060803000000,
  "MCID":"OrderItem_MC",
  "Metric Array":
	[ 
      		{
         	"Metric ID":"customerID",
         	"Metric Name":"CustomerID",
         	"Metric Sortable":"false",
         	"Metric Type":"STRING"
      		},
      		{
         	"Metric ID":"customerName",
         	"Metric Name":"CustomerName",
         	"Metric Sortable":"false",
         	"Metric Type":"STRING"
      		},
      		{
         	"Metric ID":"dateOrdered",
         	"Metric Name":"Date Ordered",
         	"Metric Sortable":"false",
        	 "Metric Type":"DATETIME"
      		}	    
	]
}

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: Versioned Monitoring Context Metrics Resource