appnotification EntityType
Notification to be provided to a user.
- Entity set path:
- [organization URI]/api/data/v9.2/appnotifications
- Base type:
- crmbaseentity
- Table type:
- Elastic
- Display name:
- Notification
- Primary key:
- appnotificationid
- Primary name column:
- 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
|
||||||||||||||
| 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
|
||||||||||||||
| 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
|
||||||||||||||
| 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 |
| DeleteMultiple | Not Bound |
| PurgeRetainedContent | Not Bound |
| Retain | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RollbackRetain | Not Bound |
| UpdateMultiple | Not Bound |
| UpsertMultiple | Not Bound |
| ValidateRetentionConfig | Not Bound |