The CheckOut client API is used to check out documents.
Argument |
Description |
---|---|
Parameter 1 |
Show hidden files |
Parameter 1 default |
False |
Parameter 1 description |
Set to True to allow selection of hidden files (Non-viewable and Non-editable files) |
Parameter 1 type |
Boolean |
Parameter 2 |
RestrictedFileTypeUIDs |
Parameter 2 default |
None |
Parameter 2 description |
The file types are restricted from download or copy during checkout. |
Parameter 2 type |
String |
Parameter 3 |
Checkout top files |
Parameter 3 default |
True |
Parameter 3 description |
If set to True, allows selective check out of files for the selected document. If set to False, all files associated with the document are checked out. |
Parameter 3 type |
Boolean |
Parameter 4 |
Not used |
Parameter 5 |
Run Editor |
Parameter 5 default |
False |
Parameter 5 description |
If set to True, opens the checked-out files in the associated editor. If set to False, the files are checked out but not opened automatically. |
Parameter 5 type |
Boolean |
Parameter 6 |
ColumnSetForRunEdtior |
Parameter 6 default |
CS_RunEditorColumnSet |
Parameter 6 description |
The column set to be used in the Run Editor dialog box. |
Parameter 6 type |
String |
Parameter 7 |
Copy nested references for CPR |
Parameter 7 default |
True |
Parameter 7 description |
If set to True, copy nested references for CPR (Copy for Reference). If set to False, the nested references are not copied automatically. |
Parameter 7 type |
Boolean |
Parameter 8 |
Not used |
Parameter 9 |
Not used |
Parameter 10 |
Not used |
Parameter 11 |
Replace document version in UI |
Parameter 11 default |
True |
Parameter 11 description |
If set to True, replaces the previous document version with the new version in the UI on check out instead of adding the new version to the New Items window. |
Parameter 11 type |
Boolean |
Parameter 12 |
Not Used |
Parameter 13 |
Not Used |
Parameter 14 |
Not Used |
Parameter 15 |
Allow references |
Parameter 15 default |
True |
Parameter 15 description |
Allow reference files during checkout operation. By default it is set to True, which means references files will be shown for checkout |
Parameter 15 type |
Boolean |
The following methods use the CheckOut client API to check out documents.
-
VersionCheckOut
-
RunEditor