Projects.Agile.TimeEntries Entity

Namespace: Projects.Agile

Contains entries about the time spent working on cases. Entity: Apm_Time_Entries (Introduced in version 25.1.2.78)

Default Visualization

Default Display Text Format:
{Date:d} {StartTime:hh:mm} - {EndTime:hh:mm}
Default Search Members:
__
Category: Views
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

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

Aggregate Tree

• Projects.Agile.TimeEntries

Attributes

Name	Type	Description
Date	date	The date for which the time entry is created. Required Filter(eq;ge;le) ORD
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
DurationHours	decimal (0, 0)	Total duration of the logged time (in hours). [ReadOnly]
EndTime	time nullable	The ending time of the logged work. Stored in the local time zone of the user. Empty value when the work is still in progress. Filter(eq;ge;le)
Id	guid
Notes	string (max) nullable	Notes. Filter(like)
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.
StartTime	time	The start time of the logged work. Stored in the local time zone of the user. Required Filter(eq;ge;le) ORD

References

Name	Type	Description
Case	Cases	The case for which the time is recorded. Required Filter(multi eq)
User	Users	The user for whom the time is recorded. Required Filter(multi eq) ReadOnly

Attribute Details

Date

The date for which the time entry is created. Required Filter(eq;ge;le) ORD

Type: date
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: True
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

DurationHours

Total duration of the logged time (in hours). [ReadOnly]

Type: decimal (0, 0)
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: ShownByDefault

EndTime

The ending time of the logged work. Stored in the local time zone of the user. Empty value when the work is still in progress. Filter(eq;ge;le)

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

Id

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

Notes

Notes. Filter(like)

Type: string (max) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 2147483647
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

StartTime

The start time of the logged work. Stored in the local time zone of the user. Required Filter(eq;ge;le) ORD

Type: time
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: True
Show in UI: ShownByDefault

Reference Details

Case

The case for which the time is recorded. Required Filter(multi eq)

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

User

The user for whom the time is recorded. Required Filter(multi eq) ReadOnly

Type: Users
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

Create a notification immediately in a separate transaction, and send 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 notification subject.
  Type: string

• priority
  The notification priority.
  Type: Systems.Core.NotificationsRepository.Priority
  Allowed values for the Priority(Systems.Core.Notifications.md#priority) data attribute
  Allowed Values (Systems.Core.NotificationsRepository.Priority Enum Members)

  Value	Description
  Background	Background value. Stored as 1. Model Value: 1 Domain API Value: 'Background'
  Low	Low value. Stored as 2. Model Value: 2 Domain API Value: 'Low'
  Normal	Normal value. Stored as 3. Model Value: 3 Domain API Value: 'Normal'
  High	High value. Stored as 4. Model Value: 4 Domain API Value: 'High'
  Urgent	Urgent value. Stored as 5. Model Value: 5 Domain API Value: 'Urgent'

  Optional: True
  Default Value: Normal

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

• R38519 Time Entry - End Time Is After Start Time
• R38525 Time Entry - Check Case System State
• R38545 Time Entry - Overlapping Not Allowed

Front-End Business Rules

• R38508 Time Entry - Set User

API

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

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