canvasapp EntityType

An application built through a canvas-based editing experience.

Entity Set Path
[organization URI]/api/data/v9.0/canvasapps
Base Type
crmbaseentity
Display Name
Canvas App
Primary Key
canvasappid
Primary Key Attribute
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
aadcreatedbyid Edm.String

Unique identifier of the user who created the canvas app.

Display Name: Created By

aadlastmodifiedbyid Edm.String

Unique identifier of the user who last modified the application.

Display Name: Last Modified By

aadlastpublishedbyid Edm.String

Unique identifier of the user who last published the application.

Display Name: Last Published By

admincontrolbypassconsent Edm.Boolean

Indicates whether the canvas app was marked for bypass consent by an admin.

Display Name: Admin Control Bypass Consent

Default Options
Value Label
1 True
0 False
appcomponentdependencies Edm.String

The app component dependencies.

appcomponents Edm.String

The app components.

appopenuri Edm.String

The app open URI.

appversion Edm.String

The application version.

assets Edm.Binary

Assets for Canvas Apps.

Display Name: Assets

Read Only
assets_name Edm.String
Read Only
authorizationreferences Edm.String

The authorization references of the application.

background_image Edm.Binary

Background image for Canvas Apps.

Display Name: Background Image

Read Only
backgroundcolor Edm.String

The background image color.

backgroundimage_name Edm.String
Read Only
bypassconsent Edm.Boolean

Indicates whether the canvas app should bypass consent from consumers.

Display Name: Bypass Consent

Default Options
Value Label
1 True
0 False
canconsumeapppass Edm.Boolean

The type of the canvas app.

Display Name: Can Consume App Pass

Default Options
Value Label
1 True
0 False
canvasappid Edm.Guid

For internal use only.

canvasapprowid Edm.Guid

For internal use only.

Read Only
canvasapptype Edm.Int32

The type of the canvas app.

Display Name: Canvas App Type

Default Options
Value Label
0 Classic Canvas App
1 App Component Library
2 Custom Canvas Page
3 Unified App
cdsdependencies Edm.String

Internal use. The app dependency details.

commitmessage Edm.String

The commit message of the app.

Display Name: The commit message.

componentstate Edm.Int32

For internal use only.

Display Name: Component State

Read Only
Default Options
Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
connectionreferences Edm.String

The connection references of the application.

createdbyclientversion Edm.String

The version of the client that was used to author the application.

createdtime Edm.DateTimeOffset

Date and time when the application was created.

Display Name: Created Time

databasereferences Edm.String

The database references of the application.

description Edm.String

The description of the app.

Display Name: The description.

displayname Edm.String

The display name of the app.

document Edm.Binary

Document for Canvas Apps.

Display Name: Document

Read Only
document_name Edm.String
Read Only
embeddedapp Edm.String

Internal use. The embedded app information.

galleryitemid Edm.String

The gallery item identifier.

Display Name: The gallery item identifier

introducedversion Edm.String

Version in which the canvas app is introduced.

Display Name: Introduced Version

iscdsupgraded Edm.Boolean

Indicates whether the canvas app contains CDS 1.0 references.

Display Name: Is CDS Upgraded

Default Options
Value Label
1 True
0 False
iscustomizable BooleanManagedProperty

Information that specifies whether this component can be customized.

Display Name: Customizable

isfeaturedapp Edm.Boolean

Indicates whether the canvas app is a featured app.

Display Name: Is Featured App

Default Options
Value Label
1 True
0 False
isheroapp Edm.Boolean

Indicates whether the canvas app is a hero app.

Display Name: Is Hero App

Default Options
Value Label
1 True
0 False
ishidden Edm.Boolean

Indicates whether the canvas app is hidden from a user's list.

Display Name: Is Hidden

Default Options
Value Label
1 True
0 False
ismanaged Edm.Boolean

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

Display Name: Is Managed

Read Only
Default Options
Value Label
1 Managed
0 Unmanaged
large_icon Edm.Binary

Large icon for Canvas Apps.

Display Name: Large Icon

Read Only
largeicon_name Edm.String
Read Only
lastmodifiedtime Edm.DateTimeOffset

Date and time when the application was last modified.

Display Name: Last Modified Time

lastpublishtime Edm.DateTimeOffset

Date and time when the application was last published.

Display Name: Last Publish Time

medium_icon Edm.Binary

Medium icon for Canvas Apps.

Display Name: Medium Icon

Read Only
mediumicon_name Edm.String
Read Only
minclientversion Edm.String

The version of the client that was used to author the application.

name Edm.String

Name of the CanvasApp

Display Name: CanvasApp Name

overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
publisher Edm.String

The publisher of the app.

small_icon Edm.Binary

Small icon for Canvas Apps.

Display Name: Small Icon

Read Only
smallicon_name Edm.String
Read Only
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
status Edm.String

A value indicating whether the application is ready for consumption.

Display Name: Status

tags Edm.String

The metadata tags of the application.

teams_icon Edm.Binary

Teams icon for Canvas Apps.

Display Name: Teams Icon

Read Only
teamsicon_name Edm.String
Read Only
uniquecanvasappid Edm.String

The globally unique canvas app id

Display Name: Unique CanvasApp Id

versionnumber Edm.Int64
Read Only
wide_icon Edm.Binary

Wide icon for Canvas Apps.

Display Name: Wide Icon

Read Only
wideicon_name Edm.String
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 Retrieve data about lookup properties.

Name Single-valued navigation property Description
_ownerid_value ownerid

Unique identifier of the user or team who owns the canvas app.

_owningbusinessunit_value owningbusinessunit

Unique identifier of the business unit that owns the process.

_owningteam_value ownerid

Unique identifier of the team who owns the process.

_owninguser_value ownerid

Unique identifier of the user who owns the process.

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
backgroundimage fileattachment FileAttachment_CanvasApp_BackgroundImage
FK_CanvasApp_Solution solution FK_CanvasApp_Solution
largeicon fileattachment FileAttachment_CanvasApp_LargeIcon
mediumicon fileattachment FileAttachment_CanvasApp_MediumIcon
ownerid principal owner_canvasapp
owningbusinessunit businessunit businessunit_canvasapp
smallicon fileattachment FileAttachment_CanvasApp_SmallIcon
teamsicon fileattachment FileAttachment_CanvasApp_TeamsIcon
wideicon fileattachment FileAttachment_CanvasApp_WideIcon

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
canvasapp_appaction_onclickeventformulacomponentlibraryid appaction OnClickEventFormulaComponentLibraryId
canvasapp_appaction_visibilityformulacomponentlibraryid appaction VisibilityFormulaComponentLibraryId
canvasapp_FileAttachments fileattachment objectid_canvasapp

Operations

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

Name Binding
GrantAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

Solutions

The following solutions include the canvasapp entity type.

Name Description
Power Apps Actions Power Apps Actions

See also