General.Contacts.ActivityParticipants Entity

Namespace: General.Contacts

Contains the additional participants in the activities. These are the participating users, besides the user to which the activitiy is assigned. Entity: Cm_Activity_Participants

Default Visualization

Default Display Text Format:
{Activity.EntityName}
Default Search Members:
Activity.EntityName
Name Data Member:
Activity.EntityName
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.Contacts.Activities
Aggregate Root:
General.Contacts.Activities

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Email	string (254) nullable	Participant email. Used to identify the participant and is required when syncing with external services. `Filter(multi eq;like)` `Introduced in version 24.1.4.87`
Id	guid
Notes	string (255) nullable	Notes for this ActivityParticipant.
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.
WorkLoadPercent	decimal (3, 2)	The planned work load of the participant for this activity. `Required` `Default(1)`

References

Name	Type	Description
Activity	Activities	The to which this ActivityParticipant belongs. `Required` `Filter(multi eq)` `Owner`
ParticipantPerson	Persons (nullable)	The person, participating in an activity. `Filter(multi eq)`
User	Users (nullable)	The user associated with the Person participating in the activity. `Filter(multi eq)` `Introduced in version 24.1.5.15`

Attribute Details

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

Email

Participant email. Used to identify the participant and is required when syncing with external services. Filter(multi eq;like) Introduced in version 24.1.4.87

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

Back-End Default Expression:
GetRelatedUserEmailAddress( obj.ParticipantPerson)

Front-End Recalc Expressions:
GetRelatedUserEmailAddress( obj.ParticipantPerson)

Id

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

Notes

Notes for this ActivityParticipant.

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

WorkLoadPercent

The planned work load of the participant for this activity. Required Default(1)

Type: decimal (3, 2)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 1
Show in UI: ShownByDefault

Reference Details

Activity

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

Type: Activities
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

ParticipantPerson

The person, participating in an activity. Filter(multi eq)

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

User

The user associated with the Person participating in the activity. Filter(multi eq) Introduced in version 24.1.5.15

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

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