Projects.Todo.Tasks Entity

Namespace: Projects.Todo

Represents a task, such as a piece of work or personal item, that can be tracked and completed. Entity: Gen_Todo_Tasks (Introduced in version 23.1.1.39)

Default Visualization

Default Display Text Format:
{Title}
Default Search Members:
__
Category: Definitions
Show in UI: ShownByDefault
API access: ReadWrite

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.Todo.Tasks
- Projects.Todo.TaskItems

Attributes

Name	Type	Description
CompletedDateTimeUtc	datetime nullable	Indicates (in UTC) when the task was completed. `Filter(eq;ge;le)` `ReadOnly`
CreationTimeUtc	datetime	Indicates (in UTC) when the task was created. `Required` `Default(NowUtc)` `Filter(eq;ge;le)` `ORD` `ReadOnly` `Introduced in version 26.1.4.61`
DisplayText	string
DueDate	date nullable	Indicates when the task should be finished. `Filter(eq;ge;le)` `ORD`
ExternalId	string	The id of the object, when it is imported/synchronized with external system. Used by sync apps to identify the object in external systems. [Filter(multi eq)] [ORD] [Introduced in version 24.1.0.89]
ExternalSystem	string	The name of the external system from which the object is imported/synchronized. [Filter(multi eq)] [Introduced in version 24.1.0.89]
Id	guid
Importance	Importance	The importance of the task. `Required` `Default("N")` `Filter(eq)`
Notes	string (max) nullable	Notes for this Task. `Introduced in version 23.1.1.48`
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.
RemindTimeUtc	datetime nullable	When to remind the assigned user for the task (in UTC). `Filter(eq;ge;le)` `Introduced in version 23.1.1.51`
State	State	Indicates the current task state. `Required` `Default("N")` `Filter(multi eq)`
Title	string (254)	A brief description of the task. `Required` `Filter(like)`

References

Name	Type	Description
AssignedToUser	Users	The user, to whom the todo is assigned. `Required` `Filter(multi eq)`
DataObject	ExtensibleDataObjects (nullable)	The object for which this is a to-do item. `Filter(multi eq)` `Introduced in version 25.1.2.60`
OwnerUser	Users	The user, who created the todo and owns it. `Required` `Filter(multi eq)`
SocialGroup	Groups (nullable)	When not null, indicates that the todo is contained in and managed by the specified social group. `Filter(multi eq)`

Child Collections

Name	Type	Description
Items	TaskItems	List of `TaskItem`(Projects.Todo.TaskItems.md) child objects, based on the `Projects.Todo.TaskItem.Task`(Projects.Todo.TaskItems.md#task) back reference

Attribute Details

CompletedDateTimeUtc

Indicates (in UTC) when the task was completed. Filter(eq;ge;le) ReadOnly

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

CreationTimeUtc

Indicates (in UTC) when the task was created. Required Default(NowUtc) Filter(eq;ge;le) ORD ReadOnly Introduced in version 26.1.4.61

Type: datetime
Indexed: True
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: True
Default Value: CurrentDateTimeUtc
Show in UI: ShownByDefault

DisplayText

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

DueDate

Indicates when the task should be finished. Filter(eq;ge;le) ORD

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

ExternalId

The id of the object, when it is imported/synchronized with external system. Used by sync apps to identify the object in external systems. [Filter(multi eq)] [ORD] [Introduced in version 24.1.0.89]

Type: string
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

ExternalSystem

The name of the external system from which the object is imported/synchronized. [Filter(multi eq)] [Introduced in version 24.1.0.89]

Type: string
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

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

Importance

The importance of the task. Required Default("N") Filter(eq)

Type: Importance
Category: System
Allowed values for the Importance(Projects.Todo.Tasks.md#importance) data attribute
Allowed Values (Projects.Todo.TasksRepository.Importance Enum Members)

Value	Description
Low	Low value. Stored as 'L'. Database Value: 'L' Model Value: 0 Domain API Value: 'Low'
Normal	Normal value. Stored as 'N'. Database Value: 'N' Model Value: 1 Domain API Value: 'Normal'
High	High value. Stored as 'H'. Database Value: 'H' Model Value: 2 Domain API Value: 'High'

Supported Filters: Equals
Supports Order By: False
Default Value: Normal
Show in UI: ShownByDefault

Notes

Notes for this Task. Introduced in version 23.1.1.48

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
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

RemindTimeUtc

When to remind the assigned user for the task (in UTC). Filter(eq;ge;le) Introduced in version 23.1.1.51

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

State

Indicates the current task state. Required Default("N") Filter(multi eq)

Type: State
Category: System
Allowed values for the State(Projects.Todo.Tasks.md#state) data attribute
Allowed Values (Projects.Todo.TasksRepository.State Enum Members)

Value	Description
New	New value. Stored as 'N'. Database Value: 'N' Model Value: 0 Domain API Value: 'New'
InProgress	InProgress value. Stored as 'P'. Database Value: 'P' Model Value: 1 Domain API Value: 'InProgress'
Waiting	Waiting value. Stored as 'W'. Database Value: 'W' Model Value: 2 Domain API Value: 'Waiting'
Completed	Completed value. Stored as 'C'. Database Value: 'C' Model Value: 3 Domain API Value: 'Completed'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Default Value: New
Show in UI: HiddenByDefault

Title

A brief description of the task. Required Filter(like)

Type: string (254)
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

Reference Details

AssignedToUser

The user, to whom the todo is assigned. Required Filter(multi eq)

Type: Users
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

DataObject

The object for which this is a to-do item. Filter(multi eq) Introduced in version 25.1.2.60

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

OwnerUser

The user, who created the todo and owns it. Required Filter(multi eq)

Type: Users
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

SocialGroup

When not null, indicates that the todo is contained in and managed by the specified social group. Filter(multi eq)

Type: Groups (nullable)
Indexed: True
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

Front-End Business Rules

None

API

Domain API Entity Set: Projects_Todo_Tasks

Domain API Entity Type: Projects_Todo_Task

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

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

Table of Contents

Projects.Todo.Tasks Entity

Default Visualization

Track Changes

Aggregate

Attributes

References

Child Collections

Attribute Details

CompletedDateTimeUtc

CreationTimeUtc

DisplayText

DueDate

ExternalId

ExternalSystem

Id

Importance

Notes

ObjectVersion

RemindTimeUtc

State

Title

Reference Details

AssignedToUser

DataObject

OwnerUser

SocialGroup

API Methods

GetAllowedCustomPropertyValues

CreateNotification

CreateCopy

Business Rules

Front-End Business Rules

API