checkout_document
Check out a document from the content repository by specifying its ID or path. Optionally update document properties or download the content.
Instructions
Checks out a document in the content repository.
:param identifier: The document id or path (required). This can be either the document's ID (GUID) or its path in the repository (e.g., "/Folder1/document.pdf"). :param document_properties: Properties to update for the document during check-out. :param checkout_action: Check-out action parameters for the document. :param download_folder_path: Optional path to a folder where the document content will be downloaded. If not provided but content download is needed, the user will be prompted to provide it.
:returns: If successful, returns a Document object with its updated properties. If unsuccessful, returns a ToolError with details about the failure.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | Yes | ||
| checkout_action | No | ||
| document_properties | No | ||
| download_folder_path | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |