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

    name*
    String! non-null
    Name for this property definition.
    specificationSpecification of the property definition. It represents the data type of a property definition.
    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.
    collectionProperty definition collection in which this property definition is present.
    * Required


    Where Used

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