Get property definitions
get_property_definitionsLists property definitions (built-in and custom) with GUID, name, type, and group, so you can use them in get_property_values or set_property_values.
Instructions
Lists property definitions — built-in (ID, areas, volumes, heights, ...) and user-defined (custom) — so you can address them in get_property_values / set_property_values. Summary per definition: {guid, name, group, type (string|integer|number|length|area|volume|angle|boolean|List|singleEnum|multiEnum), kind (Custom|BuiltIn|DynamicBuiltIn), editable, description?, expressionBased?, enumValues? (options of option sets), availabilityCount? (custom), builtInName? (language-independent name of built-ins, e.g. General_ElementID)}. detail 'full' adds groupGuid, collectionType/valueType/measureType, defaultValue or defaultExpressions, enumOptions with keys, expressionReference (for expressions) and availability (classification items). Names are LOCALIZED (Russian Archicad: Russian group and property names) — use search with a Russian word, or builtInName for built-ins. Filter with search / groups / kind, or with elements / elementTypes to get only what is available for them. Returns {definitions, total, offset, returned, hasMore, groups?}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | All (default), Custom (user-defined) or BuiltIn | |
| limit | No | Return at most this many (default 500) | |
| detail | No | summary (default) or full | |
| groups | No | Only definitions in these groups | |
| offset | No | Skip this many definitions | |
| search | No | Case-insensitive substring of 'Group/Name' or the description, e.g. 'огнест' or 'Площадь' | |
| elements | No | Only definitions available for these elements (see elementMatch) | |
| properties | No | Only these definitions (resolve references to full details) | |
| elementMatch | No | With elements/elementTypes: available for all of them (default) or any | |
| elementTypes | No | Only definitions available for the tool defaults of these element types | |
| includeGroups | No | Also return all property groups {guid, name, kind, description?, definitionCount} | |
| includeAvailability | No | Resolve availability to classification items {guid, id, name?, system} (default: true with detail full) | |
| includeBuiltInNames | No | Add builtInName to built-in definitions (default true; 2 extra official API calls, cached) |