Check Out Asset
cascade_check_outLock a Cascade asset for exclusive editing by creating a working copy that only you can edit. Required before modifying files or binary content.
Instructions
Lock a Cascade asset for exclusive editing.
Check-out creates a working copy of the asset that only the authenticated user can edit; other users see the previously committed version until check-in. Required for some asset types (especially files and binary content types) before cascade_edit will succeed. The response includes a workingCopyIdentifier that represents the locked working copy for subsequent calls. Always pair with cascade_check_in when editing finishes to release the lock.
Args:
identifier (object, required): The asset to check out
id (string, optional): Asset ID (preferred)
path (object, optional): { path, siteId OR siteName }
type (string, required): Entity type of the asset
Returns: Cascade OperationResult: { success: true, workingCopyIdentifier?: { id, type, path: { path, siteId, siteName } } } On failure: { success: false, message: "" }
Examples:
Use when: "Lock a page before editing" -> { identifier: { type: "page", id: "..." } }
Use when: "Check out a file for binary replacement" -> { identifier: { type: "file", path: { path: "/assets/logo.png", siteName: "www" } } }
Don't use when: You've finished editing — use cascade_check_in to release.
Don't use when: Read-only operations — checkout isn't needed for cascade_read.
Error Handling:
"Asset not found" when the identifier doesn't resolve
"Already checked out" when another user holds the lock
"Permission denied" when credentials lack edit rights. Responses are JSON text; structuredContent is authoritative when the response fits. Oversized responses return bounded _cache metadata for cascade_read_response. For cascade_read, read_mode controls preview versus raw Cascade payload shape.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| identifier | No | The asset to check out (creates a working copy for exclusive editing). |