canvasapp EntityType

Reference

Namespace:: Microsoft.Dynamics.CRM

An application built through a canvas-based editing experience.

Entity set path:: [organization URI]/api/data/v9.2/canvasapps
Base type:: crmbaseentity
Table type:: Standard
Display name:: Canvas App
Primary key:: canvasappid
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

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

Values	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

Values	Label
1	True
0	False

canconsumeapppass

Edm.Boolean

The type of the canvas app.

Display name: Can Consume App Pass

Default options

Values	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

Values	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

Values	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

Values	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

Values	Label
1	True
0	False

isheroapp

Edm.Boolean

Indicates whether the canvas app is a hero app.

Display name: Is Hero App

Default options

Values	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

Values	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

Values	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

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

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
canvasapp_msdyn_mobileapp_msdyn_primaryPublishedAppName	msdyn_mobileapp	msdyn_primaryPublishedAppName

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

Share via

canvasapp EntityType

Properties

Lookup properties

Single-valued navigation properties

Collection-valued navigation properties

Operations

See also

Additional resources