PblDelete

Project Build Library (PBL) file and directory delete interface. This function is used to permanently remove files and directories in the Project Build Library. This function may be useful if you are building your own PBL client.

URL

/cubit_api/1/pbl_delete

Authentication

This method requires authentication using an API key.

Parameters

comment ( zero or once ): An optional comment to leave about the operation being performed. This will not appear in the PBL, but it will be in the audit log entry for this event.; Type: String
dryrun ( Required, once ): If this parameter is set to True, the specified path will not actually be deleted. The only valid value for this parameter is True.; Type: String
force ( zero or once ): If the force option is present and set to True, and the specified path argument is a directory, a recursive delete of the directory will be performed. The only valid value for this parameter is True.; Type: String
path ( Required, once ): The path to the file being operated on. For example, if the complete file URL is /pbl/zork/pub/foo/bar/test.txt, the path would be /foo/bar/test.txt; Type: String
proj ( Required, once ): The name of the project which contains the file we are operating on.; Type: String
sig ( Required, once ): API authentication hash signature.; Type: String
type ( Required, once ): The type of file that we are operating on. Valid values are 'pub' and 'priv'.; Type: String
userid ( Required, once ): The login name of the user initiating the request.; Type: String

Example Response

        
    <?xml version='1.0'?>
    <cubit version='1'>
        <status>OK</status>
    </cubit>

Response Codes

200 - ok
400 - Login failed / Insufficient permissions