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


Cube - Version-specific Cube Resource - GET Method

Resource URI

GET /models/{model id}/versions/{version}/mcs/{mc id}/cube?{parameters}

Parameters

Optional Parameters
NameValue TypeDescription
returndbname boolean
Whether to return the database names required to access database tables and columns. For example, schema name, monitoring context view name, metric column name, etc
ValueDescription
true
Return the database names required to access database tables and columns.
false (default)
Do not return the database names required to access the database tables and columns.

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

string

The monitor model version

MCID

string

The monitoring context ID

Dashboard Cube Name

string

The Dashboard cube name

Database Schema

string

The Database schema. This property is returned if and only if returndbname=true.

Database View

string

The database view name for this version of the monitoring context. This property is returned if and only if returndbname=true.

Measure Array

array

Array to contain a list of measures for this monitoring context

 

Measure ID

string

The measure ID

 

Measure Name

string

The measure name

 

Dashboard Measure Name

string

The dashboard measure name

 

Aggregation Type

string

The measure aggregation type. The valid values are “avg”, “sum”, “min”, “max” ”, “count” and “stddev”.

 

Measure Data Type

string

The measure data type. The valid values are “integer”, “decimal”, “duration”, “date”, “time”, “datetime

 

Tracking Key

string

The tracking key.

 

Metric ID

string

The associated metric ID.

 

Metric Database Column

string

The database column name for the metric in the monitoring context view. This column can be used to get the value of the metric from the view. This property is returned if and only if returndbname=true.

Dimension Array

array

Array to contain a list of dimensions for this monitoring context

 

Dimension ID

string

The dimension ID

 

Dimension Name

string

The dimension name

 

Dashboard Dimension Name

string

The dashboard dimension name

 

Dimension Data Type

string

The dimension data type. The valid values are “normal” and “date”.

 

Dimension Level Array

array

Array to contain a list of dimension levels

 

 

Dimension Level ID

string

The dimension level ID

 

 

Dimension Level Name

string

The dimension level name

 

 

Dimension Level Data Type

string

The dimension level data type. The valid values are “STRING”, “INTEGER”, “DECIMAL”, “BOOLEAN”, “DURATION”, “DATE”, “TIME”, “DATETIME”, “COUNTER”, “STOPWATCH-NA” and “STOPWATCH-A”.

 

 

Dashboard Dimension Level Name

string

The dashboard dimension level name.

 

 

Level

integer

The level number.

 

 

Metric ID

string

The metric ID associated with this level.

 

 

Metric Database Column

string

The database column name for the metric in the monitoring context view. This column can be used to get the value of the metric from the view. This property is returned if and only if returndbname=true.

 


+ View Schema
{ "description": "Versioned Monitoring Context Cube", 
  "type": "object",
  "properties":
   {   "Model ID":{"type":"string"},
	"MCID":{"type":"string"},
	"Version":{"type":"string"},
	"Dashboard Cube Name":{"type":"string"},
	"Database Schema":{"type":"string",
		  "optional": true,
		  "description": "This property is returned if and only if returndbname=true."},
	"Database View":{"type":"string",
		"optional": true,
		"description": "This property is returned if and only if returndbname=true."},
	"Measure Array":[
			{ "Measure ID": {"type":"string"},
			  "Measure Name": {"type":"string"},
			  "Dashboard Measure Name": {"type":"string"},
			  "Aggregation Type": {"type":"string"},
			  "Measure Data Type": {"type":"string",
						"enum":["integer","decimal","duration","date",
							"time","datetime"]},
			  "Tracking Key": {"type":"string"},
			  "Metric ID": {"type":"string"},
			  "Metric Database Column": {"type":"string",
		  			    "optional": true,
		  			    "description": "This property is returned if and only 
							if returndbname=true."},
			}
		   ]
	 "Dimension Array":[
			{ "Dimension ID": {"type":"string"},
			  "Dimension Name": {"type":"string"},
         		  "Dashboard Dimension Name":{"type":"string"},
         		  "Dimension Data Type":{"type":"string",
						 "enum":["normal","date"],
						 "description":"If dimension attribute is date or 
								datetime, then dimension data type 
								is date; otherwise, dimension data 
								type is normal."},
			  "Dimension Level Array": [
					{ "Dimension Level ID": {"type":"string"},
					  "Dimension Level Name": {"type":"string"},
					  "Dimension Level Data Type":{"type":"string",
						       		       "description":"The data type of the 
										associated metric."
									"enum":["STRING", "INTEGER", "DECIMAL",
										"BOOLEAN", "DURATION", "DATE", 
										"TIME", "DATETIME", "COUNTER", 
										"STOPWATCH-NA", "STOPWATCH-A"]},
					  "Dashboard Dimension Level Name": {"type":"string"},
					  "Level": {"type":"Integer"},
					  "Metric ID": {"type":"string"},
					  "Metric Database Column": {"type":"string",
		  					    "optional": true,
		  					    "description": "This property is returned if 
								and only if returndbname=true."},
					}
				    ]
			}
		      ],
   }
}

Example content:

{
   "Model ID":"OrderItem",
   "Version":"20060803000000",
   "MCID":"OrderItem_MC",
   "Dashboard Cube Name":"ORDERITEM_ORDERITEM_MC_CUBE_20060803000000",
   "Database Schema":"ORDERITEM",
   "Database View":"MCV_ORDERITEMMC_20060803000000",
   "Dimension Array":[
      {
         "Dimension ID":"CatalogActivityCounter"
         "Dimension Name":"Catalog Activity Counter",
         "Dashboard Dimension Name":"Catalog Activity Counter",
         "Dimension Data Type":"normal",
         "Dimension Level Array":[
            {
               "Dimension Level ID":"catalogActivityCounter",
               "Dimension Level Name":"catalog Activity Counter"
               "Dimension Level Data Type":"COUNTER",
               "Dashboard Dimension Level Name":"catalog Activity Counter",
               "Level":1,
               "Metric ID":"catalogActivityCounter",
               "Metric Database Column":"C_CATALOGACTIVITYCOUNTER",
            }
         ],
      },
      {
         "Dimension ID":"CreationTime"
         "Dimension Name":"CreationTime",
         "Dashboard Dimension Name":"CreationTime",
         "Dimension Data Type":"date",
         "Dimension Level Array":[
            {
               "Dimension Level ID":"Day",
               "Dimension Level Name":"Day"
               "Dimension Level Data Type":"DATETIME",
               "Dashboard Dimension Level Name":"Day",
               "Level":3,
               "Metric ID":"CreationTime",
               "Metric Database Column":"CREATION_TIME",
            },
            {
               "Dimension Level ID":"Month",
               "Dimension Level Name":"Month"
               "Dimension Level Data Type":"DATETIME",
               "Dashboard Dimension Level Name":"Month",
               "Level":2,
               "Metric ID":"CreationTime",
               "Metric Database Column":"CREATION_TIME",
            },
            {
               "Dimension Level ID":"Year",
               "Dimension Level Name":"Year"
               "Dimension Level Data Type":"DATETIME",
               "Dashboard Dimension Level Name":"Year",
               "Level":1,
               "Metric ID":"CreationTime",
               "Metric Database Column":"CREATION_TIME",
            }
         ],
      },
   ],
   "Measure Array":[
      {
         "Measure ID":"avgAccumulatingStopwatch",
         "Measure Name":"Avg Accumulating Stopwatch",
         "Dashboard Measure Name":"Avg Accumulating Stopwatch",
         "Aggregation Type":"avg",
         "Measure Data Type":"duration",
         "Tracking Key":"avgAccumulatingStopwatch"
         "Metric ID":"accumulatingStopwatch",
         "Metric Database Column":"T1_ACCUMULATINGSTOPWATCH",
      },
      {
         "Measure ID":"countCatalogActivityCounter",
         "Measure Name":"Count Catalog Activity Counter",
         "Dashboard Measure Name":"Count Catalog Activity Counter",
         "Aggregation Type":"count",
         "Measure Data Type":"INTEGER",
         "Tracking Key":"countCatalogActivityCounter"
         "Metric ID":"catalogActivityCounter",
         "Metric Database Column":"C_CATALOGACTIVITYCOUNTER",
      },
   ]
}

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.2

Parent Topic: Version-specific Cube Resource