|
Use this API to lock the specified files for editing. When
you check out a file from the specified node, a lockable aspect
is placed on the node and a working copy of the node is created
in the destination path or a node that you specify. You can then
update the working copy.
You cannot check out a file that has already been checked out.
If you perform such a checkout operation, an exception is thrown.
The check out operation is atomic: either all nodes that you
specify are checked out, or the operation is aborted and an exception
thrown.
Input propertiesParameters that specify the store, file, and check in options.
Store NameA string value
that represents the name of the store from which you want to check
out the content. This is a mandatory parameter, and the default
value is SpacesStore.
nodeIDsOrPathsThe list of
IDs of nodes or paths that you want to check out. You can check
in only files. Checking out folders is not allowed, so the list
of nodeIDsOrPaths must correspond to files. This
value is a mandatory parameter.
To check out all content
from a space, you should get a list of all files in the space using
the getSpaceContents API. You can then check out
the files using the checkOut API and pass the node IDs thus obtained
from the result.
To selectively check out nodes, you can
use the searchRepository API to get a list of IDs
of nodes with the required criteria, and then pass these node IDs
to the checkout API.
destinationNodeOrPath(Optional) A string value
that specifies the folder where you want to checked out the files
to. If the destination folder is not specified, files are checked
out, and working copies of the checked out files are created in
the space where original files are present.
Output propertiesA map value
containing a list of IDs of working copies that correspond to IDs
of each file that is checked out.
|
|
|
