Viewing the existing schema using REST APIs

Ops Center Analyzer Detail View REST API Reference Guide

Version
11.0.x
Audience
anonymous
Part Number
MK-99ANA004-10

To view the existing schema in the Analyzer detail view server, use the following APIs.

API

URL

Result

Retrieve dataset

HTTPS://<Analyzer detail view server IP Address>:8443/dbapi.do?action=retrieveDataset&dataset=defaultDs

Example:

HTTPS://192.168.20.35:8443/dbapi.do?action=retrieveDataset&dataset=defaultDs

Returns the number of attribute definitions, resource definitions, total resource count, and list of data subset IDs.
Retrieve specific data subset

HTTPS://<Analyzer detail view server IP Address>:8443/dbapi.do?action=retrieveDataSubset&dataset=defaultDs&dataSubsetId=<Data Subset Name>

Example:

HTTPS://192.168.20.35:8443/dbapi.do?action=retrieveDataSubset&dataset=defaultDs&dataSubsetId=97542

Retrieves all attribute definitions with their details, such as ID, attribute type, attribute name, and unit of measure.
Retrieve all attribute definitions

HTTPS://<Analyzer detail view server IP Address>:8443/dbapi.do?action=retrieveAttributeDef&dataset=defaultDs

Example:

HTTPS://192.168.20.35:8443/dbapi.do?action=retrieveAttributeDef&dataset=defaultDs

Retrieves all attribute definitions with their details, such as ID, attribute type, attribute name, and unit of measure.
Retrieve specific attribute definition

HTTPS://<Analyzer detail view server IP Address>:8443/dbapi.do?action=retrieveAttributeDef&dataset=defaultDs&attrIds=<Attribute definition name>

Example:

HTTPS://192.168.20.35:8443/dbapi.do?action=retrieveAttributeDef&dataset=defaultDs&attrIds=pvolSerialNumber

Retrieves information of the specified attribute definition.
Retrieve all resource definitions

HTTPS://<Analyzer detail view server IP Address>:8443/dbapi.do?action=retrieveResourceDef&dataset=defaultDs

Example:

HTTPS://192.168.20.35:8443/dbapi.do?action=retrieveResourceDef&dataset=defaultDs

Retrieves all the resource definitions with details, such as type, name, attribute names, and relations.
Retrieve specific resource definition

HTTPS://<Analyzer detail view server IP Address>:8443/dbapi.do?action=retrieveResourceDef&dataset=defaultDs&types=<Resource Definition Name>

Example:

HTTPS://192.168.20.35:8443/dbapi.do?action=retrieveResourceDef&dataset=defaultDs&types=raidMPB

Retrieves information of the specified resource definition.
Retrieve resource data corresponding to resType/attrId/ attrValue/resSignatures

HTTPS://<Analyzer detail view server IP Address>:8443/dbapi.do?action=retrieveResourceData&dataset=defaultDs&resType=<Resource Type>

Example:

HTTPS://192.168.20.35:8443/dbapi.do?action=retrieveResourceData&dataset=defaultDs&resType=raidLdev

Retrieves all the resource data corresponding to resource type or attribute ID, attribute values, or resource signature.