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
Expand all
| name* String! non-null | Name for this property definition. |
| specification | Specification of the property definition. It represents the data type of a property definition. |
| specificationConfig | Property specific configuration. Present for types that require additional metadata (e.g. CURRENCY). |
| 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. |
| shouldDisplayInSummary | Indicates if the parameter should be displayed in the summary section of Fusion Team. |
| applicableEntityTypes | Applicable entities of the property definition. |
| collection | Property definition collection in which this property definition is present. |
| dependentPropertyIds* [ID!] non-null | Dependent Property IDs of Property definition for computed Properties. |
| isSearchable | Indicates whether the Property Definition is searchable. |
| localizedName* String! non-null | Localized name of this property definition. |
| localizedDescription | Localized description of this property definition. |
| picklistOptions* [PicklistOption!] non-null | Predefined list of values for this property. |
| localizations* [LocalizationRecord!]! non-null | Retrieves localization resources for this property definition collection. |
| filter | Specifies which language locales to return. |
* Required
Where Used
| Usage | Used By | Description |
|---|---|---|
| Field Of | ArchivePropertyDefinitionPayload | Response of archive property definition operation. |
| Field Of | ComputedProperty | Data object that represents computed property. |
| Field Of | CreatePropertyDefinitionsPayload | Response of create property definitions operation. |
| Field Of | Property | Represents a property value associated with an entity such as a component, model, or drawing. |
| Field Of | PropertyDefinitions | List of property definitions. |
| Field Of | SearchableProperty | Represents a property that can be used as a search criterion in hub-wide searches. |
| Field Of | UpdatePropertyDefinitionPayload | Response of update property definition operation. |
| Mutated By | updatePropertyDefinitionLocalization | Updates localization resources for custom property definitions. Note: Base property localization resources are locked and cannot be modified. |
| Mutated By | updateHubScopedPropertyDefinitionLocalization | Updates localization resources for hub-scoped property definitions. |