Show / Hide Table of Contents

    Systems.Core.ExtensibleDataObjects Entity

    Namespace: Systems.Core

    Extends data in other tables with attached files, custom properties, etc. Each row is an object, bound to exactly one row in the primary table. Each object can be bound to a row in a different primary table, specified in Entity_Type. Entity: Sys_Objects

    Default Visualization

    Default Display Text Format:
    {Id}: {EntityType}
    Default Search Members:
    __
    Category: Definitions
    Show in UI: ShownByDefault

    Aggregate

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

    Aggregate Tree

    • Systems.Core.ExtensibleDataObjects
      • Systems.Core.ObjectFiles
      • Systems.Core.ObjectVersions

    Attributes

    Name Type Description
    CreationTimeUtc datetime nullable The exact server time (in UTC) when the object represented by this system object was created. null means that it is unknown. Filter(ge;le) Introduced in version 19.1
    DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
    EntityItemId guid The Id of the primary row to which the object is bound. Required Filter(multi eq)
    EntityType string (64) The entity type of the row to which the object is bound. Required Default(" ") Filter(eq) ORD
    Id guid
    IsDeleted boolean Specifies whether the object represented by this system object is deleted. After deletion of the original object, the system object remains in the system, but can be purged later by some cleanup processes. Required Default(false) Filter(eq) Introduced in version 19.1
    LastUpdateTimeUtc datetime nullable The exact server time (in UTC) of the last modification of the object represented by this system object. null means that it is unknown. Filter(ge;le) Introduced in version 19.1
    LatestVersion int32 The latest saved version of the object. Starts from 1 and increments with 1 for each new version. Required Default(1)
    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.

    References

    Name Type Description
    CreationUser Users (nullable) The user, who created the object represented by this system object . null means that it is unknown. Filter(multi eq) Introduced in version 19.1
    LastUpdateUser Users (nullable) The user, who made the last modification of the object represented by this system object . null means that it is unknown. Filter(multi eq) Introduced in version 19.1

    Child Collections

    Name Type Description
    Files ObjectFiles List of ObjectFile(Systems.Core.ObjectFiles.md) child objects, based on the Systems.Core.ObjectFile.Object(Systems.Core.ObjectFiles.md#object) back reference
    Versions ObjectVersions List of ObjectVersion(Systems.Core.ObjectVersions.md) child objects, based on the Systems.Core.ObjectVersion.Object(Systems.Core.ObjectVersions.md#object) back reference

    Attribute Details

    CreationTimeUtc

    The exact server time (in UTC) when the object represented by this system object was created. null means that it is unknown. Filter(ge;le) Introduced in version 19.1

    Type: datetime nullable
    Category: System
    Supported Filters: GreaterThanOrLessThan
    Supports Order By: False
    Show in UI: ShownByDefault

    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: ****
    Show in UI: HiddenByDefault

    EntityItemId

    The Id of the primary row to which the object is bound. Required Filter(multi eq)

    Type: guid
    Category: System
    Supported Filters: Equals, EqualsIn
    Show in UI: ShownByDefault

    EntityType

    The entity type of the row to which the object is bound. Required Default(" ") Filter(eq) ORD

    Type: string (64)
    Indexed: True
    Category: System
    Supported Filters: Equals
    Supports Order By: True
    Maximum Length: 64
    Default Value: ** **
    Show in UI: ShownByDefault

    Id

    Type: guid
    Indexed: True
    Category: System
    Supported Filters: Equals, EqualsIn
    Default Value: NewGuid
    Show in UI: CannotBeShown

    IsDeleted

    Specifies whether the object represented by this system object is deleted. After deletion of the original object, the system object remains in the system, but can be purged later by some cleanup processes. Required Default(false) Filter(eq) Introduced in version 19.1

    Type: boolean
    Category: System
    Supported Filters: Equals
    Supports Order By: False
    Default Value: False
    Show in UI: ShownByDefault

    LastUpdateTimeUtc

    The exact server time (in UTC) of the last modification of the object represented by this system object. null means that it is unknown. Filter(ge;le) Introduced in version 19.1

    Type: datetime nullable
    Category: System
    Supported Filters: GreaterThanOrLessThan
    Supports Order By: False
    Show in UI: ShownByDefault

    LatestVersion

    The latest saved version of the object. Starts from 1 and increments with 1 for each new version. Required Default(1)

    Type: int32
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Default Value: 1
    Show in UI: ShownByDefault

    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: ****
    Show in UI: HiddenByDefault

    Reference Details

    CreationUser

    The user, who created the object represented by this system object . null means that it is unknown. Filter(multi eq) Introduced in version 19.1

    Type: Users (nullable)
    Category: System
    Supported Filters: Equals, EqualsIn
    Show in UI: ShownByDefault

    LastUpdateUser

    The user, who made the last modification of the object represented by this system object . null means that it is unknown. Filter(multi eq) Introduced in version 19.1

    Type: Users (nullable)
    Category: System
    Supported Filters: Equals, EqualsIn
    Show in UI: ShownByDefault

    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

    CreateNotification

    Creates a notification and sends a real time event to the user.
    Return Type: void
    Declaring Type: EntityObject
    Domain API Request: POST

    Parameters

    • user
      The user.
      Type: Users

    • notificationClass
      The notification class.
      Type: string

    • subject
      The subject.
      Type: string

    CreateCopy

    Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
    Return Type: EntityObject
    Declaring Type: EntityObject
    Domain API Request: POST

    Business Rules

    • R30224 Object - Deleting Is Not Allowed
    • R30440 Object - Client Update Not Allowed

    Front-End Business Rules

    None

    API

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

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

    • Improve this Doc
    Back to top Generated by DocFX