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:
http://<TSPShostname>:port#/tsws/10.0/api/unifiedadmin/Timeframe/<id>/delete?idType=id

Example

http://tspspanna:port#/tsws/10.0/api/unifiedadmin/Timeframe/name/delete?idType=id

Entry	Description
http\|https	Type of protocol to send the request. Infrastructure Management support both HTTP and HTTPS protocols.
serverHost	Host name of the BMC TrueSight Infrastructure Management Server that has Central Monitoring Administration
port	Port 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.
identifier1, identifier2,...identifierN	Identifiers of the time frame. The supported identifier types are as follows: Name of the time frame Identifier of the time frame 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: name tId The default value is name.

Response information for the delete API

A sample JSON response is as follows:

{
    "responseTimeStamp": "2015-03-22T20:50:38",
    "statusCode": "200",
    "statusMsg": "OK",
    "response": [
        {
            "resourceId": "edab3b79-0423-4f70-aab5-814b458919ac",
            "resourceName": "blackout-agent1",
            "resourceURI": null,
            "statusCode": "200",
            "statusMsg": "OK",
            "bladeSetup": null
        }
    ]
}

Page tree

URL to access the delete API

Response information for the delete API

Related topics