Notification (appnotification) table/entity reference

Article
08/31/2024

Notification to be provided to a user.

Messages

The following table lists the messages for the Notification (appnotification) table. Messages represent operations that can be performed on the table. They may also be events.

Name Is Event?	Web API Operation	SDK for .NET
`Assign` Event: True	`PATCH` /appnotifications(appnotificationid) Update the `ownerid` property.	AssignRequest
`Create` Event: True	`POST` /appnotifications See Create	Create records
`CreateMultiple` Event: True	CreateMultiple	CreateMultipleRequest
`Delete` Event: True	`DELETE` /appnotifications(appnotificationid) See Delete	Delete records
`DeleteMultiple` Event: True	DeleteMultiple	Learn to use messages with the SDK for .NET
`Retrieve` Event: True	`GET` /appnotifications(appnotificationid) See Retrieve	Retrieve records
`RetrieveEntityChanges` Event: True		RetrieveEntityChangesRequest
`RetrieveMultiple` Event: True	`GET` /appnotifications See Query data	Query data
`RetrievePrincipalAccess` Event: True	RetrievePrincipalAccess	RetrievePrincipalAccessRequest
`Update` Event: True	`PATCH` /appnotifications(appnotificationid) See Update	Update records
`UpdateMultiple` Event: True	UpdateMultiple	UpdateMultipleRequest
`Upsert` Event: True	`PATCH` /appnotifications(appnotificationid) See Upsert a table row	UpsertRequest
`UpsertMultiple` Event: True	UpsertMultiple	UpsertMultipleRequest

Events

The following table lists the events for the Notification (appnotification) table. Events are messages that exist so that you can subscribe to them. Unless you added the event, you shouldn't invoke the message, only subscribe to it.

Name	Web API Operation	SDK for .NET
`BulkRetain`	BulkRetain	Learn to use messages with the SDK for .NET
`PurgeRetainedContent`	PurgeRetainedContent	Learn to use messages with the SDK for .NET
`Retain`	Retain	Learn to use messages with the SDK for .NET
`RollbackRetain`	RollbackRetain	Learn to use messages with the SDK for .NET
`ValidateRetentionConfig`	ValidateRetentionConfig	Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the Notification (appnotification) table.

Property	Value
DisplayName	Notification
DisplayCollectionName	Notifications
SchemaName	`appnotification`
CollectionSchemaName	`appnotifications`
EntitySetName	`appnotifications`
LogicalName	`appnotification`
LogicalCollectionName	`appnotifications`
PrimaryIdAttribute	`appnotificationid`
PrimaryNameAttribute	`title`
TableType	`Elastic`
OwnershipType	`UserOwned`

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

AppModuleId
appnotificationId
Body
Data
IconType
ImportSequenceNumber
OverriddenCreatedOn
OwnerId
OwnerIdType
PartitionId
Priority
TimeZoneRuleVersionNumber
Title
ToastType
TTLInSeconds
UTCConversionTimeZoneCode

AppModuleId

Property	Value
Description	This field is not used
DisplayName	Model-driven app
IsValidForForm	True
IsValidForRead	True
LogicalName	`appmoduleid`
RequiredLevel	None
Type	Lookup
Targets	appmodule

appnotificationId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Notification
IsValidForForm	False
IsValidForRead	True
LogicalName	`appnotificationid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

Body

Property	Value
Description	Body of the notification
DisplayName	Body
IsValidForForm	True
IsValidForRead	True
LogicalName	`body`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	500

Data

Property	Value
Description	Custom data for the notification that can be used by the notification card
DisplayName	Data
IsValidForForm	True
IsValidForRead	True
LogicalName	`data`
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	5000

IconType

Property	Value
Description
DisplayName	IconType
IsValidForForm	True
IsValidForRead	True
LogicalName	`icontype`
RequiredLevel	None
Type	Picklist
DefaultFormValue	100000000
GlobalChoiceName	`notification_iconid`

IconType Choices/Options

Value	Label
100000000	Info
100000001	Success
100000002	Failure
100000003	Warning
100000004	Mention
100000005	Custom

ImportSequenceNumber

Property	Value
Description	Sequence number of the import that created this record.
DisplayName	Import Sequence Number
IsValidForForm	False
IsValidForRead	True
LogicalName	`importsequencenumber`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-2147483648

OverriddenCreatedOn

Property	Value
Description	Date and time that the record was migrated.
DisplayName	Record Created On
IsValidForForm	False
IsValidForRead	True
LogicalName	`overriddencreatedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateOnly
ImeMode	Inactive
SourceTypeMask	0

OwnerId

Property	Value
Description	Owner Id
DisplayName	Owner
IsValidForForm	True
IsValidForRead	True
LogicalName	`ownerid`
RequiredLevel	SystemRequired
Type	Owner
Targets	systemuser, team

OwnerIdType

Property	Value
Description	Owner Id Type
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`owneridtype`
RequiredLevel	SystemRequired
Type	EntityName

PartitionId

Property	Value
Description	Partitioning will be based on owner and it is recommended to specify this field for all operations for performance reason
DisplayName	Partition Id
IsValidForForm	True
IsValidForRead	True
LogicalName	`partitionid`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

Priority

Property	Value
Description	Priority of the notification
DisplayName	Priority
IsValidForForm	True
IsValidForRead	True
LogicalName	`priority`
RequiredLevel	None
Type	Picklist
DefaultFormValue	200000000
GlobalChoiceName	`notification_priority`

Priority Choices/Options

Value	Label
200000000	Normal
200000001	High

TimeZoneRuleVersionNumber

Property	Value
Description	For internal use only.
DisplayName	Time Zone Rule Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	`timezoneruleversionnumber`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

Title

Property	Value
Description	Title for the notification
DisplayName	Title
IsValidForForm	True
IsValidForRead	True
LogicalName	`title`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	256

ToastType

Property	Value
Description	Type of toast behavior for the notification
DisplayName	Toast Type
IsValidForForm	True
IsValidForRead	True
LogicalName	`toasttype`
RequiredLevel	None
Type	Picklist
DefaultFormValue	200000000
GlobalChoiceName	`notification_toasttype`

ToastType Choices/Options

Value	Label
200000000	Timed
200000001	Hidden

TTLInSeconds

Property	Value
Description	After the specified number of seconds the notification will be deleted
DisplayName	Expiry (seconds)
IsValidForForm	True
IsValidForRead	True
LogicalName	`ttlinseconds`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	1

UTCConversionTimeZoneCode

Property	Value
Description	Time zone code that was in use when the record was created.
DisplayName	UTC Conversion Time Zone Code
IsValidForForm	False
IsValidForRead	True
LogicalName	`utcconversiontimezonecode`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

CreatedBy
CreatedOn
CreatedOnBehalfBy
ModifiedBy
ModifiedOn
ModifiedOnBehalfBy
OwnerIdName
OwnerIdYomiName
OwningBusinessUnit
OwningTeam
OwningUser
VersionNumber

CreatedBy

Property	Value
Description	Unique identifier of the user who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

CreatedOn

Property	Value
Description	Date and time when the record was created.
DisplayName	Created On
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

CreatedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who created the record.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedBy

Property	Value
Description	Unique identifier of the user who modified the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedOn

Property	Value
Description	Date and time when the record was modified.
DisplayName	Modified On
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

ModifiedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who modified the record.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

OwnerIdName

Property	Value
Description	Name of the owner
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`owneridname`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OwnerIdYomiName

Property	Value
Description	Yomi name of the owner
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`owneridyominame`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OwningBusinessUnit

Property	Value
Description	Unique identifier for the business unit that owns the record
DisplayName	Owning Business Unit
IsValidForForm	True
IsValidForRead	True
LogicalName	`owningbusinessunit`
RequiredLevel	None
Type	Lookup
Targets	businessunit

OwningTeam

Property	Value
Description	Unique identifier for the team that owns the record.
DisplayName	Owning Team
IsValidForForm	False
IsValidForRead	True
LogicalName	`owningteam`
RequiredLevel	None
Type	Lookup
Targets	team

OwningUser

Property	Value
Description	Unique identifier for the user that owns the record.
DisplayName	Owning User
IsValidForForm	False
IsValidForRead	True
LogicalName	`owninguser`
RequiredLevel	None
Type	Lookup
Targets	systemuser

VersionNumber

Property	Value
Description	Version Number
DisplayName	Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	`versionnumber`
RequiredLevel	None
Type	BigInt
MaxValue	9223372036854775807
MinValue	-9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

appmodule_appnotification_app
business_unit_appnotification
lk_appnotification_createdby
lk_appnotification_createdonbehalfby
lk_appnotification_modifiedby
lk_appnotification_modifiedonbehalfby
owner_appnotification
team_appnotification
user_appnotification

appmodule_appnotification_app

One-To-Many Relationship: appmodule appmodule_appnotification_app

Property	Value
ReferencedEntity	`appmodule`
ReferencedAttribute	`appmoduleid`
ReferencingAttribute	`appmoduleid`
ReferencingEntityNavigationPropertyName	`AppModuleId`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

business_unit_appnotification

One-To-Many Relationship: businessunit business_unit_appnotification

Property	Value
ReferencedEntity	`businessunit`
ReferencedAttribute	`businessunitid`
ReferencingAttribute	`owningbusinessunit`
ReferencingEntityNavigationPropertyName	`owningbusinessunit`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_appnotification_createdby

One-To-Many Relationship: systemuser lk_appnotification_createdby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`createdby`
ReferencingEntityNavigationPropertyName	`createdby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_appnotification_createdonbehalfby

One-To-Many Relationship: systemuser lk_appnotification_createdonbehalfby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`createdonbehalfby`
ReferencingEntityNavigationPropertyName	`createdonbehalfby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_appnotification_modifiedby

One-To-Many Relationship: systemuser lk_appnotification_modifiedby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`modifiedby`
ReferencingEntityNavigationPropertyName	`modifiedby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_appnotification_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_appnotification_modifiedonbehalfby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`modifiedonbehalfby`
ReferencingEntityNavigationPropertyName	`modifiedonbehalfby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

owner_appnotification

One-To-Many Relationship: owner owner_appnotification

Property	Value
ReferencedEntity	`owner`
ReferencedAttribute	`ownerid`
ReferencingAttribute	`ownerid`
ReferencingEntityNavigationPropertyName	`ownerid`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

team_appnotification

One-To-Many Relationship: team team_appnotification

Property	Value
ReferencedEntity	`team`
ReferencedAttribute	`teamid`
ReferencingAttribute	`owningteam`
ReferencingEntityNavigationPropertyName	`owningteam`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

user_appnotification

One-To-Many Relationship: systemuser user_appnotification

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`owninguser`
ReferencingEntityNavigationPropertyName	`owninguser`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

Share via