Listing details for a specific policy

The list API uses the GET method to list a policy. You must provide authentication credentials by using the login API before accessing the data. For information about the authentication process, see Web services authentication.

URL to access the list API

The generic format of a URL for the list API is as follows:

http|https://<tspshostname>:<port>/tsws/10.0/api/unifiedadmin/Policy/
<policyIdentifier>/list?&idType=<identifierType>

Example

http://tspspanna:80/tsws/10.0/api/unifiedadmin/Policy/policy201/list?&idType=name

Response information for the list API

A sample JSON response is as follows:

{
   "listResult": [
       {
           "monitoringPolicy": {
               "agentConfigData": {
                   "agentTag": "host123_agent_tag",
                   "agentPort": "3183",
                   "publishedHostName": "host123",
                   "domainName": "adprod.bmc.com",
                   "isphoneHome": {
                       "istype": "single",
                       "name": "leaf_host_IS_name"
                   },
                   "remoteCell": "ISCell"
               },
               "agentSelectionCriteria": "agentTag EQUALS \"Windows_agent_Policy\" OR  agentOS CONTAINS \"Windows\"",
               "enabled": true,
               "tenant": {
                   "name": "GLOBAL",
                   "id": "GLOBAL"
               },
               "precedence": 999,
               "name": "policy123",
               "policyId": "id_2",
               "type": "monitoring",
               "description": "description"
           },
           "statusCode": "200",
           "statusMsg": "OK"
       }
    ],
   "statusCode": "200",
   "statusMsg": "OK",
   "responseTimeStamp": "2012-07-25T07:34:36",
}

 

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