Show / Hide Table of Contents

    General.CustomPropertyAllowedValues Entity

    Namespace: General

    User-defined properties allowed values. Can be specified only for properties with unbound allowed values (e.g. for which Allowed Values Entity is not set). Entity: Gen_Property_Allowed_Values

    Default Visualization

    Default Display Text Format:
    {Description:T}
    Default Search Members:
    PropertyAllowedValueField; Description
    Code Data Member:
    PropertyAllowedValueField
    Name Data Member:
    Description

    Aggregate

    An aggregate is a cluster of domain objects that can be treated as a single unit.

    Aggregate Parent:
    General.CustomProperties
    Aggregate Root:
    General.CustomProperties

    Attributes

    Name Type Description
    Active boolean Specifies whether the allowed value is active and can be used when selecting property values. Required Default(true) Filter(eq)
    Description MultilanguageString (254) nullable The description of the property allowed value. Used to fill the Description column of the Property_Value in Gen_Property_Values_Table. Filter(eq;like)
    DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
    Id guid
    LongDescription string (max) nullable When not null, specifies a long description of the allowed value. This long description is only used as helper information when selecting values, it is not copied in the property value.
    ObjectVersion int32 The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
    ParentAllowedValueId guid nullable The value of the parent property, for which this allowed value is valid. Filter(multi eq)
    Picture byte[] nullable When not null, specifies a picture representation of the allowed value.
    PropertyAllowedValueField string (254) The actual allowed value. Required Filter(eq;like)

    References

    Name Type Description
    EnterpriseCompany EnterpriseCompanies (nullable) The Enterprise Company to which this CustomPropertyAllowedValue applies, or null if it is for all enterprise companies. Filter(multi eq)
    Property CustomProperties The to which this CustomPropertyAllowedValue belongs. Required Filter(multi eq) Owner

    Attribute Details

    Active

    Specifies whether the allowed value is active and can be used when selecting property values. Required Default(true) Filter(eq)

    Type: boolean
    Category: System
    Supported Filters: Equals
    Supports Order By: False
    Default Value: True

    Description

    The description of the property allowed value. Used to fill the Description column of the Property_Value in Gen_Property_Values_Table. Filter(eq;like)

    Type: MultilanguageString (254) nullable
    Category: System
    Supported Filters: Equals, Like
    Supports Order By: False

    DisplayText

    Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

    Type: string
    Category: Calculated Attributes
    Supported Filters: NotFilterable
    Supports Order By: ****

    Id

    Type: guid
    Indexed: True
    Category: System
    Supported Filters: Equals, EqualsIn
    Default Value: NewGuid

    LongDescription

    When not null, specifies a long description of the allowed value. This long description is only used as helper information when selecting values, it is not copied in the property value.

    Type: string (max) nullable
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Maximum Length: 2147483647

    ObjectVersion

    The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

    Type: int32
    Category: Extensible Data Object
    Supported Filters: NotFilterable
    Supports Order By: ****

    ParentAllowedValueId

    The value of the parent property, for which this allowed value is valid. Filter(multi eq)

    Type: guid nullable
    Category: System
    Supported Filters: Equals, EqualsIn

    Picture

    When not null, specifies a picture representation of the allowed value.

    Type: byte[] nullable
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False

    PropertyAllowedValueField

    The actual allowed value. Required Filter(eq;like)

    Type: string (254)
    Category: System
    Supported Filters: Equals, Like
    Supports Order By: False
    Maximum Length: 254

    Reference Details

    EnterpriseCompany

    The Enterprise Company to which this CustomPropertyAllowedValue applies, or null if it is for all enterprise companies. Filter(multi eq)

    Type: EnterpriseCompanies (nullable)
    Category: System
    Supported Filters: Equals, EqualsIn

    Property

    The to which this CustomPropertyAllowedValue belongs. Required Filter(multi eq) Owner

    Type: CustomProperties
    Indexed: True
    Category: System
    Supported Filters: Equals, EqualsIn
    Filterable Reference: True

    API Methods

    Methods that can be invoked in public APIs.

    GetAllowedCustomPropertyValues

    Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
    Return Type: Collection Of CustomPropertyValue
    Declaring Type: EntityObject
    Domain API Request: GET

    Parameters

    • customPropertyCode
      The code of the custom property
      Type: string

    • search
      The search text - searches by value or description. Can contain wildcard character %.
      Type: string
      Optional: True
      Default Value: null

    • exactMatch
      If true the search text should be equal to the property value
      Type: boolean
      Optional: True
      Default Value: False

    • orderByDescription
      If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
      Type: boolean
      Optional: True
      Default Value: False

    • top
      The top clause - default is 10
      Type: int32
      Optional: True
      Default Value: 10

    • skip
      The skip clause - default is 0
      Type: int32
      Optional: True
      Default Value: 0

    Business Rules

    None

    Front-End Business Rules

    None

    API

    Domain API Query: https://demodb.my.erp.net/api/domain/odata/General_CustomPropertyAllowedValues?$top=10

    Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#General_CustomPropertyAllowedValues?$top=10

    • Improve this Doc
    Back to top Generated by DocFX