Del via


appaction EntityType

Contains Modern Command Information

Entity set path: 
[organization URI]/api/data/v9.2/appactions
Base type: 
crmbaseentity
Table type: 
Standard
Display name: 
App Action
Primary key: 
appactionid
Primary name column: 
name
Operations supported: 
POST GET PATCH DELETE

Properties

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

Name Type Details
appactionid Edm.Guid

Unique identifier for entity instances

Display name: App Action

buttonaccessibilitytext Edm.String

Display name: Accessibility Text for Modern Command Button

buttonlabeltext Edm.String

Label Text renders for Modern Command Button

Display name: Button Label Text

buttonsequencepriority Edm.Decimal

Order of the Modern Command Button (Depreciated)

Display name: Button Sequence Priority (Depreciated)

buttontooltipdescription Edm.String

Tooltip Description for Modern Command Button

Display name: Button Tooltip Description

buttontooltiptitle Edm.String

Tooltip Title for Modern Command Button

Display name: Button Tooltip Title

clienttype Edm.String

Client Type associated with Modern Command

Display name: Client Type

Default options
Values Label
0 Browser
1 Mobile
2 Mail App
componentidunique Edm.Guid

For internal use only.

Display name: Row id unique

Read only
componentstate Edm.Int32

For internal use only.

Display name: Component State

Read only
Default options
Values Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
context Edm.Int32

Context scope associated with Modern Command

Display name: Context

Default options
Values Label
0 All
1 Entity
contextvalue Edm.String

Context Name associated with Modern Command

Display name: Context Value

createdon Edm.DateTimeOffset

Date and time when the record was created.

Display name: Created On

Read only
fonticon Edm.String

Font Icon for Modern Command Button

Display name: Font Icon

grouptitle Edm.String

Group Title for Modern Command Group Button

Display name: Group Title

hidden Edm.Boolean

Display name: Hidden

Default options
Values Label
1 Yes
0 No
importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display name: Import Sequence Number

iscustomizable BooleanManagedProperty

For internal use only.

Display name: Is Customizable

isdisabled Edm.Boolean

Flag indicates the Modern Command Button is disabled for end user usage i.e. ribbon equivalent will be shown

Display name: IsDisabled

Default options
Values Label
1 Yes
0 No
isgrouptitlehidden Edm.Boolean

Flag indicates the Modern Command Group Button Title is hidden

Display name: isGroupTitleHidden

Default options
Values Label
1 Yes
0 No
ismanaged Edm.Boolean

Indicates whether the solution component is part of a managed solution.

Display name: Is Managed

Read only
Default options
Values Label
1 Managed
0 Unmanaged
location Edm.Int32

Location of the Command bar associated with the Modern Command.

Display name: Location

Default options
Values Label
0 Form
1 Main Grid
2 Sub Grid
3 Associated Grid
4 Quick Form
5 Global Header
6 Dashboard
modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display name: Modified On

Read only
name Edm.String

The name of the AppAction entity.

Display name: Name

onclickeventformulacomponentlibrary Edm.String

Name of the Component Library where FX Action stored.

Display name: On Click Event Formula Component Library

onclickeventformulacomponentname Edm.String

Name of the Component for FX Modern Command.

Display name: On Click Event Formula Component Name

onclickeventformulafunctionname Edm.String

Name of the Function for FX Modern Command.

Display name: On Click Event Formula Function Name

onclickeventjavascriptfunctionname Edm.String

Name of the Function for JS Modern Command.

Display name: On Click Event JavaScript Function Name

onclickeventjavascriptparameters Edm.String

Parameters of the Function for JS Modern Command.

Display name: On Click Event JavaScript Parameters

onclickeventtype Edm.Int32

Type of Action associated with Modern Command.

Display name: On Click Event Type

Default options
Values Label
0 None
1 Formula
2 JavaScript
origin Edm.Int32

Origin of App Action.

Display name: Origin

Default options
Values Label
0 Default
1 Migrated
2 Enhanced Migrated
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display name: Record Created On

overwritetime Edm.DateTimeOffset

For internal use only.

Display name: Record Overwrite Time

Read only
sequence Edm.Decimal

Order of the Modern Command to be Displayed.

Display name: Sequence

solutionid Edm.Guid

Unique identifier of the associated solution.

Display name: Solution

Read only
statecode Edm.Int32

Status of the App Action

Display name: Status

Default options
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the App Action

Display name: Status Reason

Default options
Values Label
1 Active
2 Inactive
timezoneruleversionnumber Edm.Int32

For internal use only.

Display name: Time Zone Rule Version Number

type Edm.Int32

Type of Modern Command Button

Display name: Type

Default options
Values Label
0 Standard Button
1 Dropdown Button
2 Split Button
3 Group
uniquename Edm.String

Unique Name of the AppAction

Display name: Unique Name

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
visibilityformulacomponentlibrary Edm.String

Name of the Component Library where FX Visible Rule stored associated with Modern Command.

Display name: Visibility Formula Component Library

visibilityformulacomponentname Edm.String

Name of the Component for FX Visible Rule associated with Modern Command.

Display name: Visibility Formula Component Name

visibilityformulafunctionname Edm.String

Name of the Function for FX Visible Rule assoicated with Modern Command.

Display name: Visibility Formula Function Name

visibilitytype Edm.Int32

Visibily Type of the Modern Command which should be either FX/Classic or None.

Display name: Visibility Type

Default options
Values Label
0 None
1 Formula
2 Classic Rules

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

Unique identifier for AppModule associated with Modern Command

_contextentity_value ContextEntity

Context Entity associated with Modern Command

_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.

_iconwebresourceid_value IconWebResourceId

Unique identifier of the Icon Webresource from Webresource entity which used by the associated Modern Command

_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.

_onclickeventformulacomponentlibraryid_value OnClickEventFormulaComponentLibraryId

Unique identifier of the Component Library associated with Modern Command.

_onclickeventjavascriptwebresourceid_value OnClickEventJavaScriptWebResourceId

Unique identifier of the JavaScript WebResource from the Webresource entity which used by associated JS Modern Command.

_organizationid_value organizationid

Unique identifier for the organization

_parentappactionid_value ParentAppActionId

Unique identifier for Parent Modern Command associated with Modern Command.

_visibilityformulacomponentlibraryid_value VisibilityFormulaComponentLibraryId

Unique identifier of the Component Library associated with Modern Command.

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_appaction_appmoduleid
ContextEntity entity entity_appaction_ContextEntity
createdby systemuser lk_appaction_createdby
createdonbehalfby systemuser lk_appaction_createdonbehalfby
IconWebResourceId webresource webresource_appaction_iconwebresourceid
modifiedby systemuser lk_appaction_modifiedby
modifiedonbehalfby systemuser lk_appaction_modifiedonbehalfby
OnClickEventFormulaComponentLibraryId canvasapp canvasapp_appaction_onclickeventformulacomponentlibraryid
OnClickEventJavaScriptWebResourceId webresource webresource_appaction_onclickeventjavascriptwebresourceid
organizationid organization organization_appaction
ParentAppActionId appaction appaction_appaction
VisibilityFormulaComponentLibraryId canvasapp canvasapp_appaction_visibilityformulacomponentlibraryid

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
appaction_appaction appaction ParentAppActionId
appaction_appactionrule_classicrules appactionrule appaction_appactionrule_classicrules
appaction_AsyncOperations asyncoperation regardingobjectid_appaction
appaction_BulkDeleteFailures bulkdeletefailure regardingobjectid_appaction
appaction_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_appaction
appaction_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_appaction
appaction_ProcessSession processsession regardingobjectid_appaction
appaction_SyncErrors syncerror regardingobjectid_appaction

Operations

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

Name Binding
BulkRetain Not Bound
CreateMultiple Not Bound
DeleteMultiple Not Bound
IsValidStateTransition Not Bound
PurgeRetainedContent Not Bound
Retain Not Bound
RollbackRetain Not Bound
UpdateMultiple Not Bound
ValidateRetentionConfig Not Bound

See also