Delete

Errors

Deletes an existing vxmlapp object from the management server and undeploys it from all VXML Servers in Unified CVP.

If the vxmlapp could not be deleted from any of the servers, it will be treated as not deleted.
If the operation is repeated and if the file exists on any server, it will get deleted, otherwise “404 Not Found” response will be generated.

Note

There are some implementation implications for this operation.

The application will get undeployed only after the calls being handled by it are terminated. As the application files cannot be deleted unless the application itself gets un-deployed from the server, it is possible that sometimes the files may not get deleted from the server.
Due to the long duration it may take to undeploy, some of the requests may get FAILURE as status with TIMED_OUT reason.

Parameters of VXML File - Delete
URL	https://<ipaddress>:8111/cvp-config/vxmlapp/{appname}.
HTTP Method	DELETE.
API Type	Asynchronous.
Input/Output Format	JSON, XML.
Parameters	-
Example XML Request Payload	-
Response	The immediate response to the Delete operation is 202 Accepted. The location of the Header field is populated with asynchronous URL to fetch the status of a job.

Code Snippets
Sample JAVA code	/** * Deletes the vxml app based on the app name. * Vxml app name is passed as the path parameter with HTTP GET method. */ private static void deleteVxmlAppRequest() { Client client = getSSLClient(); ClientFilter authFilter = new HTTPBasicAuthFilter("wsmadmin", "1234Ccbu1234"); client.addFilter(authFilter); WebResource webResource = null; webResource = client.resource(BASE_URI); // DELETE the request ClientResponse clientResponse = webResource.path("/vxmlapp/<appname>"). accept(MediaType.APPLICATION_XML_TYPE).delete(ClientResponse.class); }
Sample Response Header	Delete operation is an asynchronous operation. The URL to retrieve the operation status is set against the location field of response header. `Response HTTP Status : 202 Response Headers : {Date=[Tue, 02 Apr 2013 13:33:42 GMT], Content-Length=[0], Expires=[Wed, 31 Dec 1969 16:00:00 PST], Location=[https://10.78.26.124:8111/ cvp-config/asynchrequeststatus/100013], Content-Type=[application/xml], Server=[Apache-Coyote/1.1], Pragma=[No-cache], Cache-Control=[no-cache] }`

Sample JAVA code


/**
 * Deletes the vxml app based on the app name.
 * Vxml app name is passed as the path parameter with HTTP GET method.
 */

private static void deleteVxmlAppRequest() {
	Client client = getSSLClient();
	ClientFilter authFilter = new HTTPBasicAuthFilter("wsmadmin", "1234Ccbu1234");
	client.addFilter(authFilter);

	WebResource webResource = null;
	webResource = client.resource(BASE_URI);

        // DELETE the request
        ClientResponse clientResponse = webResource.path("/vxmlapp/<appname>").
accept(MediaType.APPLICATION_XML_TYPE).delete(ClientResponse.class);
}

Sample Response Header

Delete operation is an asynchronous operation. The URL to retrieve the operation status is set against the location field of response header.


Response HTTP Status : 202
Response Headers : {Date=[Tue, 02 Apr 2013 13:33:42 GMT], Content-Length=[0], 
Expires=[Wed, 31 Dec 1969 16:00:00 PST], Location=[https://10.78.26.124:8111/
cvp-config/asynchrequeststatus/100013], Content-Type=[application/xml], 
Server=[Apache-Coyote/1.1], Pragma=[No-cache], Cache-Control=[no-cache]
}

List of Errors for VXML File - Delete
Category	HTTP Status	Error Code	Error Description
Authentication	401	authorization.unathorized	Unauthorized request.
	401	authentication.notAuthorized	User is not authorized to access the requested resource.
	401	authentication.noAccess	User is not allowed to access the resource. Check the user roles.
Bad Request	400	invalid.inputVxmlApp	Vxml App not found.
	400	invalid.invaliState	Vxml App is not in validate state to perform delete operation.
	400	invalid.format	URL cannot be decoded using UTF-8.
Unacceptable Format	406	invalid.acceptHeader	Invalid accept header, it should contain either XML or JSON.
Processing Error	500	processing.failed	Internal Error.