Request

Response

    Objects

    PropertyDefinition

    object

    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.
    specificationSpecification of the property definition. It represents the data type of a property definition.
    specificationConfigProperty specific configuration. Present for types that require additional metadata (e.g. CURRENCY).
    unitsUnit of a property definition.
    id*
    ID! non-null
    The ID of property definition.
    propertyBehavior*Behavior of property definition.
    descriptionA short description of the property definition.
    isHiddenIndicates if the parameter is hidden or not in the application.
    isArchivedtrue : The property definition is archived. false : The property definition is active.
    isReadOnlyIndicates if the parameter is read-only or not in the application.
    shouldCopySpecifies 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.
    shouldDisplayInSummaryIndicates if the parameter should be displayed in the summary section of Fusion Team.
    applicableEntityTypesApplicable entities of the property definition.
    collectionProperty definition collection in which this property definition is present.
    dependentPropertyIds*
    [ID!] non-null
    Dependent Property IDs of Property definition for computed Properties.
    isSearchableIndicates whether the Property Definition is searchable.
    localizedName*
    String! non-null
    Localized name of this property definition.
    localizedDescriptionLocalized description of this property definition.
    picklistOptions*Predefined list of values for this property.
    localizations*Retrieves localization resources for this property definition collection.
    filterSpecifies which language locales to return.
    * Required


    Where Used

    UsageUsed ByDescription
    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.