Reserve (Teamwork)
reserve_elementsReserve Archicad Teamwork elements and object sets before editing, so you can lock what you need and see conflicts or the current owner. Returns reservation status; no effect in solo projects.
Instructions
Teamwork: reserves elements and/or object sets so you can edit them (elements reserved by someone else cannot be taken; the result names the owner). Output: {isTeamwork: true, elements?: [{guid, status, reserved, conflictWith?, reservedBy?} | {error}], objectSets?: [{name, status, reserved, apiError?, conflictWith?}], warning?}. Check get_teamwork_status first. In a solo (non-Teamwork) project this does nothing and returns {isTeamwork: false, message} — that is not an error: everything is editable without reservation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| elements | No | Elements to reserve/release (GUIDs) | |
| objectSets | No | Object sets to reserve/release: needed before editing attributes (e.g. 'Composites' before modifying composites, 'LayerSettings' for layers), favorites, project info or project preferences in Teamwork | |
| enableDialogs | No | Let Archicad show its own Teamwork dialogs (e.g. request/conflict messages). Default false | |
| hotlinkCacheManagement | No | Also reserve/release Hotlink Cache Management (needed to update/relink hotlinks) |