Deleting a time frame
The delete API uses the DELETE method to delete a time frame. You must provide authentication credentials by using the login API before deleting a time frame. For information about the authentication process, see
Web services authentication
URL to access the delete API
The generic format of a URL for the delete API is as follows:
https://<TSPShostname>:<port>/tsws/10.0/api/unifiedadmin/Timeframe/<id>/delete?idType=id
Example
https://tsps105:443/tsws/10.0/api/unifiedadmin/Timeframe/2b930735-40b3-4587-8add-2ce73e98a39e/delete?idType=id
| Entry | Description |
|---|---|
| https|http | Type of protocol to send the request. BMC TrueSight Presentation Server supports HTTPS protocol by default. You can use HTTP protocol as well. |
| serverHost | Host name of the Presentation Server. |
| port | Port number through which communication is established. By default, the HTTPS protocol is supported and the default port number is 443. If you use HTTP protocol, use the port number 80. |
| identifier1, identifier2,...identifierN | Identifiers of the time frame. The supported identifier types are as follows:
You can provide multiple identifiers, separated by commas. |
| idType | Specifies the identifier type for the time frame that the web service request uses. The supported identifier types are as follows:
The default value is name. |
Response information for the delete API
A sample JSON response is as follows:
{
"responseTimeStamp": "2016-04-14T10:47:32",
"statusCode": "200",
"statusMsg": "OK",
"response": [
{
"resourceId": "2b930735-40b3-4587-8add-2ce73e98a39e",
"resourceName": "TimeFrame_Weekly",
"resourceURI": null,
"statusCode": "200",
"statusMsg": "OK"
}
]
}Related topics
Performing infrastructure monitoring functions with web services
Comments
Log in or register to comment.