Page tree

The list API uses the POST method to search and retrieve details of all the time frames. You must provide authentication credentials by using the login API before accessing the details. 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/Timeframe/list?&responseType=basic

Example

http://tsps101:port#/tsws/10.0/api/unifiedadmin/Timeframe/list?responseType=basic
EntryDescription
http|httpsType of protocol to send the request. BMC TrueSight Presentation Server supports both HTTP and HTTPS protocols.
serverHostHost name of the BMC TrueSight Presentation Server that has Central Monitoring Administration
portPort number through which communication is established. The default port number is 80 if you use the HTTP protocol and 443 if you use the HTTPS protocol.

Response information for the list API

A sample JSON response is as follows:

{
  "responseTimeStamp": "2015-04-12T09:28:05",
  "statusCode": "200",
  "statusMsg": "OK",
  "response": [
    {
      "resourceId": "2b930735-40b3-4587-8add-2ce73e98a39e",
      "resourceName": "TimeFrame_Weekly",
      "resourceURI": null,
      "statusCode": "200",
      "statusMsg": "OK",
      "timeframe": {
        "id": "2b930735-40b3-4587-8add-2ce73e98a39e",
        "name": "TimeFrame_Weekly",
        "description": "",
        "tenant": "bmcrealm",
        "startTime": "9:32",
        "endHour": {
          "time": "10:32",
          "type": "time"
        },
        "recurrencePattern": {
          "recurrence": "weekly",
          "details": {
            "daysOfWeek": "2,4"
          }
        }
      }
    },
    {
      "resourceId": "76c7ed8d-3032-4fef-961f-005b416be1d9",
      "resourceName": "TimeFrame_ex_Once",
      "resourceURI": null,
      "statusCode": "200",
      "statusMsg": "OK",
      "timeframe": {
        "id": "76c7ed8d-3032-4fef-961f-005b416be1d9",
        "name": "TimeFrame_ex_Once",
        "description": "",
        "tenant": "bmcrealm",
        "startTime": "15:43",
        "endHour": {
          "time": "1:10",
          "type": "timeDuration"
        },
        "recurrencePattern": {
          "recurrence": "once",
          "details": {
            "date": "5042016"
          }
        }
      }
    }
  ]
}

4 Comments

  1.  

    1.  

  2.  

    1.