Working with the Data API

This topic provides information about the methods that are supported by the Data API.

Time Series

The following tables list the URIs and parameter information for the Time Series data type.

Lookup the time series identifier
Method	GET
URI pattern	data/TimeSeriesDataIdentifier
Required activity	Read access to Data API
Description	Lookup the time series identifier
Request parameters	srcId seriesType lookupName objName subobjName (default=GLOBAL) location (default=UNKNOWN) Note You can specify single or multiple lookup fields in the lookupName parameter. If no lookup field is specified, the search is performed on the default lookup field.
Request body	NA
Sample request	For single lookupName SampleRequest http://hostname.domain:portnumber/dh-services/data/TimeSeriesDataIdentifier? srcId=50&seriesType=SYS&lookupName=vmpip-hvcsvr01:CU-EPEP-C-C01&objName=VRAM_ALLOCATED For multiple lookupName SampleRequest https://hostname.domain:portnumber/dh-services/data/TimeSeriesDataIdentifier? srcId=31&seriesType=SYS&lookupName=VMW_VMREF,domain-c7;PARENT_VCUUID,1b45a344-f8d2-4e61-8053-9f436859480f&objName=CPU_UTIL
Response	Time series identifier(Type:String)
Sample response	NA

Search for time series identifiers
Method	POST
URI pattern	POST dh-services/data/TimeSeriesDataIdentifier/Search
Required activity	Read access to the Data API
Description	Search for the time series identifiers
Request parameters	srcId lookupName entityId objId seriesType objName subobjName location exactMatch Important The following parameters are required: seriesType with any of these values: SYS, WKLD, or APP entityId or srcId and lookupName
Request body	Request_format <TimeSeriesIdentifier> <seriesType>SYS</seriesType> <entityId>29726</entityId> <objName>CPU_UTIL</objName> </TimeSeriesIdentifier>
Sample request	SampleRequest http://hostname.domain:portnumber/dh-services/data/TimeSeriesDataIdentifier? seriesType=SYS&entityId=29726&objName=CPU_UTL
Response	Time series identifiers (Type:TimeSeriesIdentifier)
Sample response	<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <TimeSeriesIdentifiers> <TimeSeriesIdentifier> <entityId>29726</entityId> <objId>434138</objId> <seriesType>SYS</seriesType> <objName>CPU_UTIL</objName> <subobjName>GLOBAL</subobjName> </TimeSeriesIdentifier> <TimeSeriesIdentifier> <entityId>29726</entityId> <objId>434136</objId> <seriesType>SYS</seriesType> <objName>CPU_UTILMHZ</objName> <subobjName>GLOBAL</subobjName> </TimeSeriesIdentifier> <TimeSeriesIdentifier> <entityId>29726</entityId> <objId>434477</objId> <seriesType>SYS</seriesType> <objName>CPU_UTILMHZ_HM</objName> <subobjName>GLOBAL</subobjName> </TimeSeriesIdentifier> </TimeSeriesIdentifiers>

Extract the time series data from data warehouse
Method	GET
URI pattern	data/TimeSeriesData
Required activity	Read access to Data API
Description	Extract time series data for a specific system (identified by series identifier) from the TrueSight Capacity Optimization data warehouse.
Request parameters	seriesIdentifier seriesType resolution statistic fromDate (format =yyyy-MM-dd HH:mm:ss) toDate (yyyy-MM-dd HH:mm:ss)
Request body	NA
Sample request	SampleRequest http://hostname.domain:portnumber/dh-services/data/TimeSeriesData?seriesIdentifier=105708&seriesType=SYS&resolution=DH&statistic=AVGVALUE
Response	TimeSeriesResponse <?xml version="1.0" encoding="UTF-8"?> <TIMESERIES xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.0" xsi:noNamespaceSchemaLocation="timeseries.xsd"> <DATASOURCE COMPONENTID="12" SRCID="44" MSGSTAT="" /> <SERIESLIST> <SERIES STAGESTATUS="RAW" STATISTIC="AVGVALUE" SYSNM="testSysNm" OBJNM="OBJnm" SUBOBJNM="SubOBJNM" GOLEVELS="GOLEVELS"> <![CDATA[ 2012-09-12 10:36:39;3600;0.22; ]]> </SERIES> </SERIESLIST> </TIMESERIES>
Sample response	SampleResponse <?xml version="1.0" encoding="UTF-8"?> <TIMESERIES xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:noNamespaceSchemaLocation="timeseries.xsd"> <DATASOURCE COMPONENTID="4"/> <SERIESLIST> <SERIES OBJNM="BYFS_FREE" STAGESTATUS="DH" STATISTIC="AVGVALUE" SUBOBJNM="C\" SYSNM="bcm-vcenter"> <DATA> <![CDATA[2012-08-21 04:00:00;158400;1.4238613504E102012-08-21 11:00:00;133200;1.4322499584E102012-08-21 17:00:00;111600; 1.4060355584E102012-08-22 11:00:00;133200;1.436024832E102012-08-22 23:00:00;90000;1.4499708928E102012-08-23 05:00:00;154800; 1.43917056E102012-08-27 06:00:00;151200;1.2794724352E102012-08-27 12:00:00;129600;1.26877696E102012-08-27 18:00:00;108000; 1.2851347456E102012-08-28 19:00:00;104400;1.2737052672E102012-08-29 01:00:00;169200;1.2694061056E102012-08-29 20:00:00;100800; 1.2953059328E102012-08-30 19:00:00;104400;1.2812550144E102012-08-31 02:00:00;165600;1.28712704E102012-09-01 08:00:00;144000; 1.275068416E102012-09-02 09:00:00;140400;1.275068416E102012-09-02 20:00:00;100800;1.2638486528E102012-09-03 02:00:00;165600; 1.2379488256E102012-09-03 19:00:00;104400;1.2338593792E102012-09-03 21:00:00;97200;1.2279873536E102012-09-04 04:00:00;158400; 1.217396736E102012-09-04 19:00:00;104400;1.2129927168E102012-09-05 13:00:00;126000;4.9359618048E102012-09-05 19:00:00;104400; 4.9253711872E102012-09-06 01:00:00;169200;4.9132077056E102012-09-06 07:00:00;147600;4.8920264704E102012-09-06 13:00:00;126000; 4.8815407104E102012-09-06 19:00:00;104400;4.9016733696E102012-09-09 01:00:00;169200;4.8946479104E102012-09-09 07:00:00;147600; 4.883218432E102012-09-12 04:00:00;158400;4.8820649984E102012-09-12 17:00:00;111600;4.8851058688E102012-09-14 05:00:00;154800; 4.877975552E102012-09-14 11:00:00;133200;4.867489792E102012-09-15 05:00:00;154800;4.915724288E102012-09-16 20:00:00;100800; 4.88374272E102012-09-16 23:00:00;90000;4.9013587968E102012-09-17 22:00:00;93600;4.8692723712E102012-09-18 00:00:00;172800; 4.8992616448E102012-09-18 01:00:00;169200;4.8992616448E102012-09-19 09:00:00;140400;4.8840572928E102012-09-24 03:00:00;162000; 4.8762978304E102012-09-25 09:00:00;140400;4.8738861056E102012-09-25 15:00:00;118800;4.8924459008E102012-09-25 21:00:00;97200; 4.8794435584E102012-09-26 03:00:00;162000;4.8794435584E102012-09-28 15:00:00;118800;4.8919216128E102012-09-30 03:00:00;162000;4.8772415488E10]]> </DATA> </SERIES> </SERIESLIST> </TIMESERIES>

Load time series data into database
Method	POST
URI pattern	data/TimeSeriesData
Required activity	Write access to Data API
Description	Load time series data in the TrueSight Capacity Optimization database.
Request parameters	List<TimeSeriesMessage>
Request body	TimeSeriesRequest <?xml version="1.0" encoding="UTF-8"?> <TIMESERIES xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.0" xsi:noNamespaceSchemaLocation="timeseries.xsd"> <DATASOURCE COMPONENTID="12" SRCID="44" MSGSTAT="" /> <SERIESLIST> <SERIES STAGESTATUS="RAW" STATISTIC="AVGVALUE" SYSNM="testSysNm" OBJNM="OBJnm" SUBOBJNM="SubOBJNM" GOLEVELS="GOLEVELS"> <![CDATA[ 2012-09-12 10:36:39;3600;0.22; ]]> </SERIES> </SERIESLIST> </TIMESERIES>
Sample request	SampleRequest <?xml version="1.0" encoding="UTF-8"?> <TIMESERIES xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.0" xsi:noNamespaceSchemaLocation="timeseries.xsd"> <DATASOURCE COMPONENTID="2" SRCID="28"> <SERIESLIST> <SERIES MLLOOKUP="true" SYSNM="vl-pun-bcm-qa12" OBJNM="DRS_NUM" SUBOBJNM="GLOBAL" MLWEAKFIELDS="HOSTNAME##PARENT_HOSTNAME&&NAME##PARENT_VCNAME&&PARENT_CLUSTERNAME&&NAME##NAME" TIMEZONE>="-28800" STAGESTATUS="NORMAL" DS_SYSNM="HOSTNAME#vl-pun-bcm-qa12##PARENT_VCNAME#BCM-VCENTER##NAME#vl-pun-bcm-qa12##PARENT_HOSTNAME#pe-pun-bcm- dv02.bmc.com##_COMPATIBILITY_#42148df4-96bc-e2e8-5cf2-f07d158e8625##UUID#42148df4-96bc-e2e8-5cf2-f07d158e8625 ##VMW_VMREF#vm-457##PARENT_VCUUID#63BA5246-A098-407F-B797-89E5E1B145D4" LOCATIONNM="UNKNOWN" SYSTYPENM="gm:vmw" VALTYPE="COUNT" DSSUBOBJNM="GLOBAL" MLSTRONGFIELDS="UUID##PARENT_VCUUID&&VMW_VMREF"> <DATA> <![CDATA[2012-06-25 04:00:00;1800;0.0]]> </DATA> </SERIES> </SERIESLIST> </TIMESERIES>
Response	TimeSeriesResponse <?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:simpleType name="OperationStatus"> <xs:restriction base="xs:string"> <xs:enumeration value="OK"/> <xs:enumeration value="ERROR"/> <xs:enumeration value="WARNING"/> </xs:restriction> </xs:simpleType> <xs:element name="ResponseMessage"> <xs:complexType> <xs:sequence> <xs:element name="status" type="OperationStatus"/> <xs:element name="message" type="xs:string"/> <xs:element name="detail" type="xs:string" minOccurs="0"/> <xs:element name="errorCode" type="xs:string" minOccurs="0"/> <xs:element name="stackTrace" type="xs:string" minOccurs="0"/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Sample response	SampleResponse <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ResponseMessage> <status>OK</status> <message>The TimeSeriesMessage message has been successfully saved.</message> </ResponseMessage>

Custom Structure

The following tables list the URIs and parameter information for the Custom Structure data type.

Get custom structure data from data warehouse
Method	POST
URI pattern	data/ExtractCustomStructureData
Required activity	Read access to Data API
Description	Get custom structure data from the TrueSight Capacity Optimization data warehouse.
Request parameters	TableName List<Columns> (multiple and optional) List<RowFilters> (multiple and optional)
Request body	CustomStructureRequest <xs:element name="CustomStructureRequest"> <xs:complexType> <xs:sequence> <xs:element name="tableName" type="xs:string" /> <xs:element name="columnFilter" type="xs:string" minOccurs="0" maxOccurs="unbounded" /> <xs:element name="rowFilter" minOccurs="0" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="addCondition" type="xs:string" /> <xs:element name="column" type="xs:string" /> <xs:element name="operator" type="xs:string" /> <xs:element name="value" type="xs:string" /> <xs:element name="includeValue" type="xs:boolean" /> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element>
Sample request	Endpoint SampleRequest https://hostname.domain:portnumber/dh-services/data/ExtractCustomStructureData SampleRequest <CustomStructureRequest> <tableName>RESOURCE_COUNTER</tableName> <columnFilter>RESNAME</columnFilter><columnFilter>DATASETID</columnFilter><rowFilter> <addCondition></addCondition> <column>DATASETID</column> <operator>like</operator> <value>105</value> <includeValue>true</includeValue> </rowFilter> </CustomStructureRequest>
Response	CustomStructureResponse <?xml version="1.0" encoding="UTF-8"?> <CUSTOMSTRUCTURE xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:noNamespaceSchemaLocation="customstructure.xsd"> <DATASOURCE COMPONENTID="4" SOURCE="DATAHUB" SRCID=""/> <INFO EXTRACTIONDATE="2012-09-24 12:39:03" TABLENAME="TableName" BEHAVIOUR="APPEND" MSGTYPE="msgtype"> <DESCRIPTION><![CDATA[...]]></DESCRIPTION> <!--optional--> <COLUMNS> <COLUMN type="NUMBER" isPk="true">name</COLUMN> <COLUMN type="DATE">foo</COLUMN> <COLUMN type="NUMBER">value</COLUMN> </COLUMNS> </INFO> <DATA> <![CDATA[ val1;val2;val3 val1a;val2a;val3a val1s;val2s;val3s val1d;val2d;val3d ]]> </DATA> </CUSTOMSTRUCTURE>
Sample response	SampleResponse <?xml version="1.0" encoding="UTF-8"?> <CUSTOMSTRUCTURE xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:noNamespaceSchemaLocation="customstructure.xsd"> <DATASOURCE COMPONENTID="4" SOURCE="DATAHUB" SRCID=""/> <INFO BEHAVIOUR="" EXTRACTIONDATE="2012-10-01 04:38:55" MSGTYPE="" TABLENAME="RESOURCE_COUNTER"/> <COLUMNS> <COLUMN>RESNAME</COLUMN> <COLUMN>DATASETID</COLUMN> </COLUMNS> <DATA> <![CDATA[BYSNAPSHOT_SIZE;105 SNAPSHOT_SIZE;105 ]]> </DATA> </CUSTOMSTRUCTURE>

Load custom structure data into database
Method	POST
URI pattern	data/CustomStructureData
Required activity	Write access to Data API
Description	Load custom structure data in the TrueSight Capacity Optimization database.
Request parameters	List<CustomStructureMessage>
Request body	CustomStructureRequest <?xml version="1.0" encoding="UTF-8"?> <CUSTOMSTRUCTURE xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:noNamespaceSchemaLocation="customstructure.xsd"> <DATASOURCE COMPONENTID="4" SOURCE="DATAHUB" SRCID=""/> <INFO EXTRACTIONDATE="2012-09-24 12:39:03" TABLENAME="TableName" BEHAVIOUR="APPEND" MSGTYPE="msgtype"> <DESCRIPTION>< ![CDATA<a href=!...\]></DESCRIPTION> <"/>\--optional-\-> <COLUMNS> <COLUMN type="NUMBER" isPk="true">name</COLUMN> <COLUMN type="DATE">foo</COLUMN> <COLUMN type="NUMBER">value</COLUMN> </COLUMNS> </INFO> <DATA> <\!\[CDATA\[ val1;val2;val3 val1a;val2a;val3a val1s;val2s;val3s val1d;val2d;val3d \]\]> </DATA> </CUSTOMSTRUCTURE>
Sample request	SampleRequest <?xml version="1.0" encoding="UTF-8"?> <CUSTOMSTRUCTURE xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:noNamespaceSchemaLocation="customstructure.xsd"> <DATASOURCE COMPONENTID="4" SOURCE="DATAHUB" SRCID="12"/> <INFO TABLENAME="ROLE" BEHAVIOUR="INSERT"> <COLUMNS> <COLUMN>ROLEID</COLUMN> <COLUMN>NAME</COLUMN> <COLUMN>DESCRIPTION</COLUMN> <COLUMN>LICMODID</COLUMN> <COLUMN>EXTERNALNAME</COLUMN> <COLUMN>ASSIGNABLE</COLUMN> </COLUMNS> </INFO> <DATA><![CDATA[-9;TEST_ROLE_2;Test role 2;;;2]]> </DATA> </CUSTOMSTRUCTURE>
Response	CustomStructureResponse <?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:simpleType name="OperationStatus"> <xs:restriction base="xs:string"> <xs:enumeration value="OK"/> <xs:enumeration value="ERROR"/> <xs:enumeration value="WARNING"/> </xs:restriction> </xs:simpleType> <xs:element name="ResponseMessage"> <xs:complexType> <xs:sequence> <xs:element name="status" type="OperationStatus"/> <xs:element name="message" type="xs:string"/> <xs:element name="detail" type="xs:string" minOccurs="0"/> <xs:element name="errorCode" type="xs:string" minOccurs="0"/> <xs:element name="stackTrace" type="xs:string" minOccurs="0"/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Sample response	SampleResponse <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ResponseMessage> <status>OK</status> <message>The CustomStructureMessage message has been successfully saved.</message> </ResponseMessage>

Data Mart

The following tables list the URIs and parameter information for the Data Mart data type.

Get information for a specific data mart
Method	GET
URI pattern	data/DataMart/{dataMartId}
Required activity	Read access to Data API
Description	Get information for a specific data mart (uniquely identified by data-mart-id)
Request parameters	NA
Request body	NA
Sample request	NA
Response	DataMartLookupResponse <?xml version="1.0" encoding="UTF-8"?> <CUSTOMSTRUCTURE xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:noNamespaceSchemaLocation="customstructure.xsd"> <DATASOURCE COMPONENTID="4" SOURCE="DATAHUB" SRCID=""/> <INFO EXTRACTIONDATE="2012-09-24 12:39:03" TABLENAME="TableName" BEHAVIOUR="APPEND" MSGTYPE="msgtype"> <DESCRIPTION><![CDATA[...]]></DESCRIPTION> <!--optional--> <COLUMNS> <COLUMN type="NUMBER" isPk="true">name</COLUMN> <COLUMN type="DATE">foo</COLUMN> <COLUMN type="NUMBER">value</COLUMN> </COLUMNS> </INFO> <DATA> <![CDATA[ val1;val2;val3 val1a;val2a;val3a val1s;val2s;val3s val1d;val2d;val3d ]]> </DATA> </CUSTOMSTRUCTURE>
Sample response	SampleResponse <?xml version="1.0" encoding="UTF-8"?> <CUSTOMSTRUCTURE xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:noNamespaceSchemaLocation="customstructure.xsd"> <DATASOURCE COMPONENTID="4" SOURCE="DATAHUB"/> <INFO EXTRACTIONDATE="2012-10-03 11:02:12" TABLENAME="ER_V_VMWARESOL_DS4_RAW_1536"/> <COLUMNS> <COLUMN>TS</COLUMN> <COLUMN>STRUCTUREID</COLUMN> <COLUMN>ENTID</COLUMN> <COLUMN>ENTNAME</COLUMN> <COLUMN>SUBOBJNAME</COLUMN> <COLUMN>LOCATIONNAME</COLUMN> <COLUMN>GOLEVS</COLUMN> <COLUMN>TOTAL_REAL_MEM</COLUMN> <COLUMN>CPU_UTILMHZ</COLUMN> <COLUMN>MEM_CONSUMED</COLUMN> <COLUMN>CPU_NUM</COLUMN> <COLUMN>GM_ON_NUM</COLUMN> <COLUMN>CPU_TOTAL_MHZ</COLUMN> <COLUMN>CPU_UTILMHZ_SLOPE</COLUMN> <COLUMN>CPU_UTILMHZ_DURATION</COLUMN> <COLUMN>MEM_CONSUMED_SLOPE</COLUMN> <COLUMN>MEM_CONSUMED_DURATION</COLUMN> <COLUMN>GM_ON_NUM_SLOPE</COLUMN> <COLUMN>GM_ON_NUM_DURATION</COLUMN> <COLUMN>VCPU_NUM</COLUMN> <COLUMN>VCPU_ON_NUM</COLUMN> <COLUMN>HOST_NUM</COLUMN> <COLUMN>NET_BIT_RATE</COLUMN> <COLUMN>MEM_OVERHEAD</COLUMN> <COLUMN>CLUSTER_FAILOVER_TOLERANCE</COLUMN> <COLUMN>VRAM_ENTITLEMENT</COLUMN> <COLUMN>VRAM_ALLOCATED</COLUMN> <COLUMN>CPU_PACKAGE_NUM</COLUMN> <COLUMN>CPU_CORES_PER_SOCKET</COLUMN> <COLUMN>SNAPSHOT_SIZE</COLUMN> <COLUMN>VIRTUALCENTER_VERSION</COLUMN> <COLUMN>VIRTUALCENTER_NAME</COLUMN> <COLUMN>HA_STATUS</COLUMN> <COLUMN>MEM_UTIL</COLUMN> <COLUMN>CPU_UTIL</COLUMN> </COLUMNS> <DATA> <![CDATA[2012-09-01 00:00:00;SYS;4646;CU-EPEP-C-C01;;;;;;;;;;;;;;;;;;;;;;;;;;;;vmpip-hvcsvr01;;; 2012-09-01 00:00:00;SYS;3830;Isrel-host;;;;;;;;;;;;;;;;;;;;;;1.03079215104E11;;;;; VMware vCenter Server 5.0.0 build-455964;BCM-VCENTER;;; 2012-09-01 00:00:00;SYS;4648;CU-EPIP-E-C01;;;;;;;;;;;;;;;;;;;;;;;;;;;;vmpip-hvcsvr01;;; 2012-09-01 00:00:00;SYS;4647;CU-EPIP-C-C01;;;;;;;;;;;;;;;;;;;;;;;;;;;;vmpip-hvcsvr01;;; 2012-09-01 00:00:00;SYS;4649;CU-EPIP-E-C41;;;;;;;;;;;;;;;;;;;;;;;;;;;;vmpip-hvcsvr01;;; 2012-09-01 00:00:00;SYS;6631;CU-EPIP-E-C41;;;;;;;;;;;;;;;;;;;;;;;;;;;;vmpip-hvcsvr01;;; 2012-09-01 00:00:00;SYS;6630;CU-EPIP-E-C01;;;;;;;;;;;;;;;;;;;;;;;;;;;;vmpip-hvcsvr01;;; 2012-09-01 00:00:00;SYS;6325;CU-EPIN-C-C01;;;;;;;;;;;;;;;;;;;;;;;;;;;;vmpin-hvcsvr01;;; 2012-09-01 00:00:00;SYS;2541;clsr-dv02;;;;;;;;;;;;;;;;;;;;;;1.03079215104E11;;;;; VMware vCenter Server 5.0.0 build-455964;BCM-VCENTER;;; 2012-09-01 00:00:00;SYS;6324;CU-EPEN-C-C01;;;;;;;;;;;;;;;;;;;;;;;;;;;;vmpin-hvcsvr01;;; 2012-09-01 00:00:00;SYS;2540;BCO-VC;;;;;;;;;;;;;;;;;;;;;;1.03079215104E11;;;;; VMware vCenter Server 5.0.0 build-455964;BCM-VCENTER;;; 2012-09-01 00:00:00;SYS;6327;CU-EPIN-E-C41;;;;;;;;;;;;;;;;;;;;;;;;;;;;vmpin-hvcsvr01;;; 2012-09-01 00:00:00;SYS;6326;CU-EPIN-E-C01;;;;;;;;;;;;;;;;;;;;;;;;;;;;vmpin-hvcsvr01;;; 2012-09-01 00:00:00;SYS;2542;CLM-hanzel-cluster;;;;;;;;;;;;;;;;;;;;;;1.03079215104E11;;;;; VMware vCenter Server 5.0.0 build-455964; BCM-VCENTER;;; 2012-09-01 00:00:00;SYS;4289;CLM-hanzel-cluster;;;;6.8705845248E10;4723.33333333333;45958767445.333405;8.0; 17.578488372093023; 19144.0;34.5752074843254;2440800;400071311.928125; 2440800;0.04717711227825358;2476800;83.10755813953489;74.50436046511628;1.0;1193994.9147286825;1383174480.0281525; 1.0;1.03079215104E11;1.37438953472E11;2.0;;166086085741; VMware vCenter Server 5.0.0 build-455964;BCM-VCENTER;0.0;68.9798486328125;24.672656250000003 2012-09-01 00:00:00;SYS;5608;CU-EPIP-C-C00;;;;;;;;;;;;;;;;;;;;;;;;;;;;vmpip-hvcsvr01;;; 2012-09-01 00:00:00;SYS;2821;CLM-CLUSTER-01;;;;;;;;;;;;;;;;;;;;;;1.03079215104E11;;;;; VMware vCenter Server 5.0.0 build-455964;AUS-R710CLM2VC1;;; 2012-09-01 00:00:00;SYS;4286;Isrel-host;;;;3.8644219904E10;1670.66666666667;34182882133.333298;4.0; 8.00436046511628;9040.0;11.6127341809826; 2440800;29643094.7899145;2440800;0;2476800;21.973837209302324;20.969476744186046;1.0;1420912.1240310078; 561549912.3112417;1.0;1.03079215104E11; 5.7982058496E10;1.0;;0;VMware vCenter Server 5.0.0 build-455964;BCM-VCENTER;0.0;89.9106380208334;18.4808258056641 2012-09-01 00:00:00;SYS;2820;CLM-CLUSTER-02;;;;;;;;;;;;;;;;;;;;;;1.03079215104E11;;;;; VMware vCenter Server 5.0.0 build-455964;AUS-R710CLM2VC1;;; 2012-09-01 00:00:00;SYS;4288;clsr-dv02;;;;6.8705845248E10;8953;62513924266.6667;8.0;21;19144.0; -10.1799788798608;2440800;13549403.6234406;2440800;0; 2476800;60;58;1.0;1713321.6744186045;1456530439.6825025;1.0;1.03079215104E11;1.2884901888E11;2.0;;436197904860; VMware vCenter Server 5.0.0 build-455964; BCM-VCENTER;0.0;93.1072526041667;46.7666101074219 2012-09-01 00:00:00;SYS;3831;BCO-VC;;;;;;;;;;;;;;;;;;;;;;1.03079215104E11;;;;; VMware vCenter Server 5.0.0 build-455964;BCM-VCENTER;;; 2012-09-01 00:00:00;SYS;3832;clsr-dv02;;;;;;;;;;;;;;;;;;;;;;1.03079215104E11;;;;; VMware vCenter Server 5.0.0 build-455964;BCM-VCENTER;;; 2012-09-01 00:00:00;SYS;3833;CLM-hanzel-cluster;;;;;;;;;;;;;;;;;;;;;;1.03079215104E11;;;;; VMware vCenter Server 5.0.0 build-455964;BCM-VCENTER;;; 2012-09-01 00:00:00;SYS;4344;CU-EPIN-E-C01;;;;;;;;;;;;;;;;;;;;;;;;;;;;vmpin-hvcsvr01;;; 2012-09-01 00:00:00;SYS;4343;CU-EPIN-C-C01;;;;;;;;;;;;;;;;;;;;;;;;;;;;vmpin-hvcsvr01;;; 2012-09-01 00:00:00;SYS;7590;CU-EPIP-C-C00;;;;;;;;;;;;;;;;;;;;;;;;;;;;vmpip-hvcsvr01;;; 2012-09-01 00:00:00;SYS;2539;Isrel-host;;;;;;;;;;;;;;;;;;;;;;1.03079215104E11;;;;; VMware vCenter Server 5.0.0 build-455964;BCM-VCENTER;;; 2012-09-01 00:00:00;SYS;4290;CLM-Cluster;;;;5.1524927488E10;7329.16666666667;45140312405.3333;8.0; 11.119186046511627;19144.0;231.085738868398; 2440800;1105544083.06451;2440800;0.17347237763966433;2476800;58.37936046511628;32.594476744186046;1.0; 1043138.9857646221;805570499.2907138;1.0; 1.03079215104E11;1.15901202432E11;2.0;;7180763311;VMware vCenter Server 5.0.0 build-455964; BCM-VCENTER;1.0;89.5118505859375;38.2844067382813 2012-09-01 00:00:00;SYS;6628;CU-EPEP-C-C01;;;;;;;;;;;;;;;;;;;;;;;;;;;;vmpip-hvcsvr01;;; 2012-09-01 00:00:00;SYS;4291;CLM-Cluster1;;;;6.8705845248E10;6393.83333333333;61781545813.333405;8.0;19;19144.0; 2.52692168864294;2440800;175251389.912607;2440800;0; 2476800;74.65406976744185;47;1.0;1965615.6279069774;1294991291.5581622;1.0;1.03079215104E11;1.21332826112E11; 2.0;;182492073634;VMware vCenter Server 5.0.0 build-455964; BCM-VCENTER;0.0;91.8082210286459;33.3986283365885 2012-09-01 00:00:00;SYS;6629;CU-EPIP-C-C01;;;;;;;;;;;;;;;;;;;;;;;;;;;;vmpip-hvcsvr01;;; 2012-09-01 00:00:00;SYS;2819;TemporaryCluster_Testing;;;;;;;;;;;;;;;;;;;;;;1.03079215104E11;;;;; VMware vCenter Server 5.0.0 build-455964;AUS-R710CLM2VC1;;; 2012-09-01 00:00:00;SYS;2108;Hou_CLM_SB_CL1;;;;5.49437046784E11;;;;;;;;;;;;;;2.0;;;;;;;;;;;;; 2012-09-01 00:00:00;SYS;2109;Hou_CLM_WT_GP1;;;;1.37359261696E12;;;;;;;;;;;;;;6.0;;;;;;;;;;;;; 2012-09-01 00:00:00;SYS;2818;CLM-Management-CLUSTER1;;;;;;;;;;;;;;;;;;;;;;1.03079215104E11;;;;; VMware vCenter Server 5.0.0 build-455964;AUS-R710CLM2VC1;;; ]]> </DATA> </CUSTOMSTRUCTURE>

Lookup data mart based on request parameters
Method	POST
URI pattern	data/LookupDataMart
Required activity	Read access to Data API
Description	Lookup data mart based on request parameters
Request parameters	Data mart name Data mart physical name
Request body	DataMartLookupRequest <?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="DataMartLookupRequest"> <xs:complexType> <xs:sequence> <xs:element name="name" type="xs:string" minOccurs="0" maxOccurs="1" /> <xs:element name="physicalName" type="xs:string" minOccurs="0" maxOccurs="1" /> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Sample request	SampleRequest <DataMartLookupRequest> <name>AIX_VF_001_RAW</name> </DataMartLookupRequest>
Response	DataMartLookupResponse <?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:simpleType name="DataMartType"> <xs:restriction base="xs:string"> <xs:enumeration value="ANALYSIS" /> <xs:enumeration value="SQL" /> <xs:enumeration value="MVIEW" /> <xs:enumeration value="VTEMPL" /> </xs:restriction> </xs:simpleType> <xs:element name="DataMart"> <xs:complexType> <xs:attribute name="dataMartId" type="xs:long" /> <xs:attribute name="name" type="xs:string" /> <xs:attribute name="physicalName" type="xs:string" /> <xs:attribute name="creationDate" type="xs:string" /> <xs:attribute name="solution" type="xs:string" /> <xs:attribute name="type" type="DataMartType" /> </xs:complexType> </xs:element> <xs:element name="DataMarts"> <xs:complexType> <xs:sequence> <xs:element ref="DataMart" minOccurs="1" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Sample response	SampleResponse <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <DataMarts> <DataMart type="ANALYSIS" creationDate="2012-06-19 04:08:22" physicalName="ER_V_AIX_VF_001_RAW_1551" name="AIX_VF_001_RAW" dataMartId="1551"/> </DataMarts>

Indicator

The following tables list the URIs and parameter information for the Indicator data type.

Return indicator value for the given entity
Method	GET
URI pattern	data/Indicator/{indicatorName}/{systemIdentifier}
Required activity	Read access to Data API
Description	Return indicator value for the given entity. For example: data/Indicator/IND_CPU_SPARE_WU/SYS123
Request parameters	NA
Request body	NA
Sample request	NA
Response	Indicator value (text/plain)
Sample response	NA

Return all the indicators for the given entity
Method	GET
URI pattern	data/Indicators/{systemIdentifier}
Required activity	Read access to Data API
Description	Return all the indicators for the given entity. For example: data/Indicators/SYS123
Request parameters	NA
Request body	NA
Sample request	NA
Response	IndicatorResponse <?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="Indicator"> <xs:complexType> <xs:simpleContent> <xs:extension base="xs:string"> <xs:attribute name="name" type="xs:string" use="required"/> </xs:extension> </xs:simpleContent> </xs:complexType> </xs:element> <xs:element name="Indicators"> <xs:complexType> <xs:sequence> <xs:element ref="Indicator" minOccurs="0" maxOccurs="unbounded" /> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Sample response	SampleResponse <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Indicators> <Indicator name="IND_CPU_SIZE ">8 SPECINTRATE2006</Indicator> <Indicator name="IND_MEM_SIZE ">8</Indicator> <Indicator name="IND_DISK_SIZE ">200</Indicator> </Indicators>

Working with the Data API

Time Series

Lookup the time series identifier

Search for time series identifiers

Extract the time series data from data warehouse

Load time series data into database

Custom Structure

Get custom structure data from data warehouse

Load custom structure data into database

Data Mart

Get information for a specific data mart

Lookup data mart based on request parameters

Indicator

Return indicator value for the given entity

Return all the indicators for the given entity

On this page