Objects
PropertyDefinition
Data object that represents property definition.
Property definition is an object that acts as a template to create properties on an entity.
Fields
name* String! non-null | Name for this property definition. |
specification | Specification of the property definition. It represents the data type of a property definition. |
units | Unit of a property definition. |
id* ID! non-null | The ID of property definition. |
propertyBehavior* PropertyBehaviorEnum! non-null | Behavior of property definition. |
description | A short description of the property definition. |
isHidden | Indicates if the parameter is hidden or not in the application. |
isArchived | true : The property definition is archived. false : The property definition is active. |
isReadOnly | Indicates if the parameter is read-only or not in the application. |
shouldCopy | Specifies expected behavior for the property on document data management operation like ‘copy’ in Autodesk authoring apps. A value of ‘true’ means the property will be copied along to the new document on such operations. |
collection | Property definition collection in which this property definition is present. |
* Required
Where Used
Usage | Used By | Description |
---|---|---|
Field Of | ArchivePropertyDefinitionPayload | Response of archive property definition operation. |
Field Of | CreatePropertyDefinitionPayload | Response of create property definition operation. |
Field Of | CreatePropertyDefinitionsPayload | Response of create property definitions operation. |
Field Of | Property | Data object that represents property. |
Field Of | PropertyDefinitions | List of property definitions. |
Field Of | UpdatePropertyDefinitionPayload | Response of update property definition operation. |