appnotification EntityType

Notification to be provided to a user.

Entity Set Path
[organization URI]/api/data/v9.2/appnotifications
Base Type
crmbaseentity
Display Name
Notification
Primary Key
appnotificationid
Primary Key Attribute
title
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
appnotificationid Edm.Guid

Unique identifier for entity instances

Display Name: Notification

body Edm.String

Body of the notification

Display Name: Body

createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
data Edm.String

Custom data for the notification that can be used by the notification card

Display Name: Data

icontype Edm.Int32

Display Name: IconType

Default Options
Values Label
100000000 Info
100000001 Success
100000002 Failure
100000003 Warning
100000004 Mention
100000005 Custom
importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

partitionid Edm.String

Partitioning will be based on owner and it is recommended to specify this field for all operations for performance reason

Display Name: Partition Id

priority Edm.Int32

Priority of the notification

Display Name: Priority

Default Options
Values Label
200000000 Normal
200000001 High
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

title Edm.String

Title for the notification

Display Name: Title

toasttype Edm.Int32

Type of toast behavior for the notification

Display Name: Toast Type

Default Options
Values Label
200000000 Timed
200000001 Hidden
ttlinseconds Edm.Int32

After the specified number of seconds the notification will be deleted

Display Name: Expiry (seconds)

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version Number

Display Name: Version Number

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.

Name Single-valued navigation property Description
_appmoduleid_value AppModuleId

This field is not used

_createdby_value createdby

Unique identifier of the user who created the record.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the record.

_modifiedby_value modifiedby

Unique identifier of the user who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the record.

_ownerid_value ownerid

Owner Id

_owningbusinessunit_value owningbusinessunit

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
AppModuleId appmodule appmodule_appnotification_app
createdby systemuser lk_appnotification_createdby
createdonbehalfby systemuser lk_appnotification_createdonbehalfby
modifiedby systemuser lk_appnotification_modifiedby
modifiedonbehalfby systemuser lk_appnotification_modifiedonbehalfby
ownerid principal owner_appnotification
owningbusinessunit businessunit business_unit_appnotification
owningteam team team_appnotification
owninguser systemuser user_appnotification

Operations

The following operations can be used with the appnotification entity type.

Name Binding
BulkRetain Not Bound
CreateMultiple Not Bound
PurgeRetainedContent Not Bound
Retain Not Bound
RetrievePrincipalAccess Not Bound
RollbackRetain Not Bound
UpdateMultiple Not Bound
UpsertMultiple Not Bound
ValidateRetentionConfig Not Bound

See also