Show / Hide Table of Contents

    General.Resources.ResourceAvailability Entity

    Namespace: General.Resources

    Contains the resources availability for the different periods. Each period is a separate record. The availability of a resource for any given date is determined by the sum of all availability periods that include it. Entity: Gen_Resource_Availability

    Default Visualization

    Default Display Text Format:
    {Resource.Name:T}
    Default Search Members:
    Resource.Name
    Name Data Member:
    Resource.Name
    Category: Definitions
    Show in UI: ShownByDefault

    Aggregate

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

    Aggregate Parent:
    General.Resources.Resources
    Aggregate Root:
    General.Resources.ResourceGroups

    Attributes

    Name Type Description
    AvailableResources decimal (12, 2) The quantity of the resource, available for the specified period. For non-discrete resources, this number can contain fractions. When several availability periods for a resource overlap, the total availability is the sum of all. Required Default(1)
    DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
    FromDate date The date from which availability starts. Required
    Id guid
    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.
    ToDate date nullable The date to which the availability continues. When null, the availability continues infinitely.

    References

    Name Type Description
    Resource Resources The resource, for which we provide availability. Required Filter(multi eq) Owner

    Attribute Details

    AvailableResources

    The quantity of the resource, available for the specified period. For non-discrete resources, this number can contain fractions. When several availability periods for a resource overlap, the total availability is the sum of all. Required Default(1)

    Type: decimal (12, 2)
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Default Value: 1
    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

    FromDate

    The date from which availability starts. Required

    Type: date
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Show in UI: ShownByDefault

    Id

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

    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

    ToDate

    The date to which the availability continues. When null, the availability continues infinitely.

    Type: date nullable
    Category: System
    Supported Filters: NotFilterable
    Supports Order By: False
    Show in UI: ShownByDefault

    Reference Details

    Resource

    The resource, for which we provide availability. Required Filter(multi eq) Owner

    Type: Resources
    Category: System
    Supported Filters: Equals, EqualsIn
    Filterable Reference: True
    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

    None

    Front-End Business Rules

    None

    API

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

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

    • Improve this Doc
    Back to top Generated by DocFX