URI format for a resource

You can use URI as a resource identifier. A configdata request provides the URI of a specified resource in its response.

Sample response of a configdata API


{
   "response": [
       {
           "monitorInstances": [
               {
                   "monitorTypeName": "Windows File System",
                   "monitorInstanceId": "bppmwsserver:21013:16",
                   "statusCode": "200",
                   "statusMsg": "OK",
                   "attributes": [
                       {
                           "attributeName": "AVAILABILITY",
                           "precision": 2,
                           "unit": "%",
                           "kpi": false
                       }
                    ],
                   "monitorInstanceName": "Windows File System"
               }
            ],
           "statusCode": "200",
           "statusMsg": "OK",
           "resourceUniqueId": "",
           "resourceId": "bppmwsserver.calbro.com",
           "resourceIdType": "Name"
       }
    ],
   "statusCode": "200",
   "statusMsg": "OK",
   "responseTimeStamp": "2011-12-19T08:47:12"
}


The generic format of a URI is as follows:

<serverName>:<monitorTypeID>:<monitorInstanceID>

where, serverName is the name of the resource, monitorTypeID is the identifier of the monitor type, and monitorInstanceID is the identifier of the monitor instance.

The URI value returned in the sample response is bppmwsserver:21013:16.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*