DeleteProcessApp

Description

This service deletes a specified process app and all its data, given the proper privilege.

Arguments

Argument	Type	Description
auth (optional)	Auth	The Auth type supplies credentials and optionally, a host name for licensing. The userId and password can be specified with HTTP BASIC or WS-SECURITY instead.
processAppName (required)	string	The name of the process app to be deleted.

Response

An empty XML response is returned:

<ae:DeleteProcessAppResponse></ae:DeleteProcessAppResponse>

The process app is deleted. Failure will not delete the process app.

Usage

This call permanently deletes the process app that you specify.

Note: DeleteProcessApp not only deletes the specified process app, but also all the data in that process app. All tables defined by the process app and all data in those tables is permanently deleted. Since the data cannot be recovered, you should consider performing a backup of your database prior to deleting the process app.

Faults

Invalid database pointer.
The process app name is not valid.
The user lacks sufficient permission.
The delete process app fails to execute.

XML

The following XML is a snippet of the payload being sent with DeleteProcessApp.

<urn:DeleteProcessApp>
    <urn:auth>
        <urn:userId>admin</urn:userId>
        <urn:password></urn:password>
        <urn:hostname>localhost</urn:hostname>
    </urn:auth>
    <urn:processAppName>Incident Management</urn:processAppName>
    <urn:options></urn:options>
</urn:DeleteProcessApp>