DELETE
"Check-out for deletion" for a specified object. An object is deleted when the activity is checked in in which the object was checked out for deletion. This is done in the workspace with which this activity is associated.
Deleting a folder including its content is handled differently: a new activity is created, the folder and its content is checked out for deletion and the activity is immediately checked in.
For the deletion of a folder with its content, there is no a separate check-in step activity. The deletion will be checked in immediately.
Syntax
|
Syntax |
DELETE [-a activityName[-dn]] [-r <--sure>]<folderItemPath> |
|
Arguments |
|
|
[-a activityName] |
If specified, the file is checked out in the given activity. If the activity is not specified, the default activity for the workspace is used. If the specified activity does not exist, it will be created. |
|
[-dn] |
Specified if the name of the activity given is the display name and not the actual name. This is only in case you specify to use an existing activity. |
|
[-r <--sure>] |
Specifies that the whole subtree starting from the given folder has to be deleted. --sure: When specifying option -r, this option has to be specified to indicate that you are sure about the operation being performed. This is because the operation of deleting a subtree is irreversible. You cannot undo a deletion. |
|
<folderItemPath> |
The path to the folder with the items to be deleted. |
|
Description |
Checks out the specified folder items for deletion. Takes the path (local/remote) as an argument. Wild characters are accepted. |
Deleting a File from the Current Folder
To delete a file a.txt from the current folder using activity A1 , execute:
delete -a A1 a.txt
Deleting a Folder With Content
To delete a folder myFolder including all its content, execute:
delete -r --sure myFolder
The -r option (recurse) means that the whole folder subtree, starting from the given folder, has to be deleted.
Since this is an operation without a separate check-in step the --sure option is needed as the confirmation of this operation.