PblMove

Project Build Library (PBL) file and directory move interface. This function may be useful if you are building your own PBL client.

URL

/cubit_api/1/pbl_move

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
destpath ( Required, once )
The path to move the destination file to. For example, if the complete file URL is /pbl/zork/pub/foo/bar/test.txt, the srcpath would be /foo/bar/test.txt. Two important things to note about this parameter:
  1. If you specify a path which does not exist, that path will be automatically created for you as part of the move.
  2. If the destpath parameter ends with a slash ("/"), the destination will be assumed to be a directory. If it does not end with a slash, the destination will be assumed to be a file.
Type: String
destprj ( zero or once )
The destination project for the file. You must have permissions to upload files into both the srcprj and the destprj, or the move will fail. If not specified, defaults to srcprj.
Type: String
desttype ( zero or once )
The destination type of the file. Valid values are 'pub' and 'priv'. If not specified, defaults to srctype.
Type: String
force ( zero or once )
If the force option is present, the file will be moved even if a file with that name currently exists, and the previous file will be deleted and replaced with this file. The only valid value for this parameter is True.
Type: String
sig ( Required, once )
API authentication hash signature.
Type: String
srcpath ( Required, once )
The path to the source file being operated on. For example, if the complete file URL is /pbl/zork/pub/foo/bar/test.txt, the srcpath would be /foo/bar/test.txt
Type: String
srcprj ( Required, once )
The project in which the source file is located.
Type: String
srctype ( Required, once )
The source type of the file. 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