Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Messages
The following table lists the messages for the App Action Rule (appactionrule) 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 |
|---|---|---|
AssociateEvent: True |
Associate records | Associate records |
CreateEvent: True |
POST /appactionrulesSee Create |
Create records |
CreateMultipleEvent: True |
CreateMultiple | CreateMultipleRequest |
DeleteEvent: True |
DELETE /appactionrules(appactionruleid)See Delete |
Delete records |
DisassociateEvent: True |
Disassociate records | Disassociate records |
IsValidStateTransitionEvent: False |
IsValidStateTransition | IsValidStateTransitionRequest |
RetrieveEvent: True |
GET /appactionrules(appactionruleid)See Retrieve |
Retrieve records |
RetrieveMultipleEvent: True |
GET /appactionrulesSee Query data |
Query data |
SetStateEvent: True |
PATCH /appactionrules(appactionruleid)Update the statecode and statuscode properties. |
SetStateRequest |
UpdateEvent: True |
PATCH /appactionrules(appactionruleid)See Update |
Update records |
UpdateMultipleEvent: True |
UpdateMultiple | UpdateMultipleRequest |
UpsertEvent: False |
PATCH /appactionrules(appactionruleid)See Upsert a table row |
UpsertRequest |
UpsertMultipleEvent: False |
UpsertMultiple | UpsertMultipleRequest |
Events
The following table lists the events for the App Action Rule (appactionrule) 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 App Action Rule (appactionrule) table.
| Property | Value |
|---|---|
| DisplayName | App Action Rule |
| DisplayCollectionName | App Action Rules |
| SchemaName | appactionrule |
| CollectionSchemaName | appactionrules |
| EntitySetName | appactionrules |
| LogicalName | appactionrule |
| LogicalCollectionName | appactionrules |
| PrimaryIdAttribute | appactionruleid |
| PrimaryNameAttribute | name |
| TableType | Standard |
| OwnershipType | OrganizationOwned |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- appactionruleId
- Context
- ContextEntity
- ContextValue
- Definition
- ImportSequenceNumber
- IsCustomizable
- name
- OverriddenCreatedOn
- statecode
- statuscode
- TimeZoneRuleVersionNumber
- Type
- UniqueName
- UTCConversionTimeZoneCode
appactionruleId
| Property | Value |
|---|---|
| Description | Unique identifier for entity instances |
| DisplayName | App Action Rule |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | appactionruleid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
Context
| Property | Value |
|---|---|
| Description | Context associated with AppActionRule Entity. |
| DisplayName | Context |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | context |
| RequiredLevel | ApplicationRequired |
| Type | Picklist |
| DefaultFormValue | -1 |
| GlobalChoiceName | appactionrule_context |
Context Choices/Options
| Value | Label |
|---|---|
| 0 | All |
| 1 | Entity |
ContextEntity
| Property | Value |
|---|---|
| Description | Context Entity associated with AppActionRule Entity. |
| DisplayName | Context Entity |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | contextentity |
| RequiredLevel | None |
| Type | Lookup |
| Targets | entity |
ContextValue
| Property | Value |
|---|---|
| Description | Context Value associated with AppActionRule Entity. |
| DisplayName | Context Value |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | contextvalue |
| RequiredLevel | None |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 150 |
Definition
| Property | Value |
|---|---|
| Description | JSON definition classic visible rule. |
| DisplayName | Definition |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | definition |
| RequiredLevel | ApplicationRequired |
| Type | Memo |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 10000 |
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 |
IsCustomizable
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Is Customizable |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | iscustomizable |
| RequiredLevel | SystemRequired |
| Type | ManagedProperty |
name
| Property | Value |
|---|---|
| Description | The name of the AppActionRule entity. |
| DisplayName | Name |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | name |
| RequiredLevel | ApplicationRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
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 |
statecode
| Property | Value |
|---|---|
| Description | Status of the App Action Rule |
| DisplayName | Status |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statecode |
| RequiredLevel | SystemRequired |
| Type | State |
| DefaultFormValue | |
| GlobalChoiceName | appactionrule_statecode |
statecode Choices/Options
| Value | Details |
|---|---|
| 0 | Label: Active DefaultStatus: 1 InvariantName: Active |
| 1 | Label: Inactive DefaultStatus: 2 InvariantName: Inactive |
statuscode
| Property | Value |
|---|---|
| Description | Reason for the status of the App Action Rule |
| DisplayName | Status Reason |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statuscode |
| RequiredLevel | None |
| Type | Status |
| DefaultFormValue | |
| GlobalChoiceName | appactionrule_statuscode |
statuscode Choices/Options
| Value | Details |
|---|---|
| 1 | Label: Active State:0 TransitionData: None |
| 2 | Label: Inactive State:1 TransitionData: None |
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 |
Type
| Property | Value |
|---|---|
| Description | Type of classic visible rule. |
| DisplayName | Type |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | type |
| RequiredLevel | ApplicationRequired |
| Type | Picklist |
| DefaultFormValue | -1 |
| GlobalChoiceName | appactionrule_type |
Type Choices/Options
| Value | Label |
|---|---|
| 0 | Enable Rule |
| 1 | Display Rule |
UniqueName
| Property | Value |
|---|---|
| Description | Unique Name for the entity. |
| DisplayName | Unique Name |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | uniquename |
| RequiredLevel | SystemRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 300 |
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.
- ComponentIdUnique
- ComponentState
- CreatedBy
- CreatedOn
- CreatedOnBehalfBy
- IsManaged
- ModifiedBy
- ModifiedOn
- ModifiedOnBehalfBy
- OrganizationId
- OverwriteTime
- SolutionId
- SupportingSolutionId
- VersionNumber
ComponentIdUnique
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Row id unique |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentidunique |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
ComponentState
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Component State |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentstate |
| RequiredLevel | SystemRequired |
| Type | Picklist |
| DefaultFormValue | |
| GlobalChoiceName | componentstate |
ComponentState Choices/Options
| Value | Label |
|---|---|
| 0 | Published |
| 1 | Unpublished |
| 2 | Deleted |
| 3 | Deleted Unpublished |
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 |
IsManaged
| Property | Value |
|---|---|
| Description | Indicates whether the solution component is part of a managed solution. |
| DisplayName | Is Managed |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | ismanaged |
| RequiredLevel | SystemRequired |
| Type | Boolean |
| GlobalChoiceName | ismanaged |
| DefaultValue | False |
| True Label | Managed |
| False Label | Unmanaged |
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 |
OrganizationId
| Property | Value |
|---|---|
| Description | Unique identifier for the organization |
| DisplayName | Organization Id |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | organizationid |
| RequiredLevel | None |
| Type | Lookup |
| Targets | organization |
OverwriteTime
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Record Overwrite Time |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | overwritetime |
| RequiredLevel | SystemRequired |
| Type | DateTime |
| CanChangeDateTimeBehavior | False |
| DateTimeBehavior | UserLocal |
| Format | DateAndTime |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
SolutionId
| Property | Value |
|---|---|
| Description | Unique identifier of the associated solution. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | solutionid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
SupportingSolutionId
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | False |
| LogicalName | supportingsolutionid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
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.
- entity_appactionrule_ContextEntity
- lk_appactionrule_createdby
- lk_appactionrule_createdonbehalfby
- lk_appactionrule_modifiedby
- lk_appactionrule_modifiedonbehalfby
- organization_appactionrule
entity_appactionrule_ContextEntity
One-To-Many Relationship: entity entity_appactionrule_ContextEntity
| Property | Value |
|---|---|
| ReferencedEntity | entity |
| ReferencedAttribute | entityid |
| ReferencingAttribute | contextentity |
| ReferencingEntityNavigationPropertyName | ContextEntity |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: RemoveLinkMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_appactionrule_createdby
One-To-Many Relationship: systemuser lk_appactionrule_createdby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | createdby |
| ReferencingEntityNavigationPropertyName | createdby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_appactionrule_createdonbehalfby
One-To-Many Relationship: systemuser lk_appactionrule_createdonbehalfby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | createdonbehalfby |
| ReferencingEntityNavigationPropertyName | createdonbehalfby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_appactionrule_modifiedby
One-To-Many Relationship: systemuser lk_appactionrule_modifiedby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | modifiedby |
| ReferencingEntityNavigationPropertyName | modifiedby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_appactionrule_modifiedonbehalfby
One-To-Many Relationship: systemuser lk_appactionrule_modifiedonbehalfby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | modifiedonbehalfby |
| ReferencingEntityNavigationPropertyName | modifiedonbehalfby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
organization_appactionrule
One-To-Many Relationship: organization organization_appactionrule
| Property | Value |
|---|---|
| ReferencedEntity | organization |
| ReferencedAttribute | organizationid |
| ReferencingAttribute | organizationid |
| ReferencingEntityNavigationPropertyName | organizationid |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
One-to-Many relationships
These relationships are one-to-many. Listed by SchemaName.
- appactionrule_AsyncOperations
- appactionrule_BulkDeleteFailures
- appactionrule_MailboxTrackingFolders
- appactionrule_PrincipalObjectAttributeAccesses
- appactionrule_ProcessSession
- appactionrule_SyncErrors
appactionrule_AsyncOperations
Many-To-One Relationship: asyncoperation appactionrule_AsyncOperations
| Property | Value |
|---|---|
| ReferencingEntity | asyncoperation |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | appactionrule_AsyncOperations |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
appactionrule_BulkDeleteFailures
Many-To-One Relationship: bulkdeletefailure appactionrule_BulkDeleteFailures
| Property | Value |
|---|---|
| ReferencingEntity | bulkdeletefailure |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | appactionrule_BulkDeleteFailures |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
appactionrule_MailboxTrackingFolders
Many-To-One Relationship: mailboxtrackingfolder appactionrule_MailboxTrackingFolders
| Property | Value |
|---|---|
| ReferencingEntity | mailboxtrackingfolder |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | appactionrule_MailboxTrackingFolders |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
appactionrule_PrincipalObjectAttributeAccesses
Many-To-One Relationship: principalobjectattributeaccess appactionrule_PrincipalObjectAttributeAccesses
| Property | Value |
|---|---|
| ReferencingEntity | principalobjectattributeaccess |
| ReferencingAttribute | objectid |
| ReferencedEntityNavigationPropertyName | appactionrule_PrincipalObjectAttributeAccesses |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
appactionrule_ProcessSession
Many-To-One Relationship: processsession appactionrule_ProcessSession
| Property | Value |
|---|---|
| ReferencingEntity | processsession |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | appactionrule_ProcessSession |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
appactionrule_SyncErrors
Many-To-One Relationship: syncerror appactionrule_SyncErrors
| Property | Value |
|---|---|
| ReferencingEntity | syncerror |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | appactionrule_SyncErrors |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
Many-to-Many relationships
These relationships are many-to-many. Listed by SchemaName.
appaction_appactionrule_classicrules
See appaction appaction_appactionrule_classicrules Many-To-Many Relationship
| Property | Value |
|---|---|
| IntersectEntityName | appaction_appactionrule_classicrules |
| IsCustomizable | False |
| SchemaName | appaction_appactionrule_classicrules |
| IntersectAttribute | appactionruleid |
| NavigationPropertyName | appaction_appactionrule_classicrules |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
appactionrule_webresource_scripts
See webresource appactionrule_webresource_scripts Many-To-Many Relationship
| Property | Value |
|---|---|
| IntersectEntityName | appactionrule_webresource_scripts |
| IsCustomizable | False |
| SchemaName | appactionrule_webresource_scripts |
| IntersectAttribute | appactionruleid |
| NavigationPropertyName | appactionrule_webresource_scripts |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
See also
Dataverse table/entity reference
Dataverse Web API Reference
appactionrule