CanvasApp Entity Reference

An application built through a canvas-based editing experience.

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/canvasapps(canvasappid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.0/canvasapps
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/canvasapps(canvasappid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess Action GrantAccessRequest
Retrieve GET [org URI]/api/data/v9.0/canvasapps(canvasappid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/canvasapps
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RevokeAccess RevokeAccess Action RevokeAccessRequest
Update PATCH [org URI]/api/data/v9.0/canvasapps(canvasappid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName Canvas Apps
DisplayCollectionName Canvas Apps
DisplayName Canvas App
EntitySetName canvasapps
IsBPFEntity False
LogicalCollectionName canvasapps
LogicalName canvasapp
OwnershipType UserOwned
PrimaryIdAttribute canvasappid
PrimaryNameAttribute name
SchemaName CanvasApp

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

AADCreatedById

Property Value
Description Unique identifier of the user who created the canvas app.
DisplayName Created By
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName aadcreatedbyid
MaxLength 100
RequiredLevel None
Type String

AADLastModifiedById

Property Value
Description Unique identifier of the user who last modified the application.
DisplayName Last Modified By
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName aadlastmodifiedbyid
MaxLength 100
RequiredLevel SystemRequired
Type String

AADLastPublishedById

Property Value
Description Unique identifier of the user who last published the application.
DisplayName Last Published By
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName aadlastpublishedbyid
MaxLength 100
RequiredLevel SystemRequired
Type String

AdminControlBypassConsent

Property Value
Description Indicates whether the canvas app was marked for bypass consent by an admin.
DisplayName Admin Control Bypass Consent
IsValidForForm False
IsValidForRead True
LogicalName admincontrolbypassconsent
RequiredLevel None
Type Boolean

AdminControlBypassConsent Options

Value Label
1 True
0 False

DefaultValue: False

AppOpenUri

Property Value
Description The app open URI.
DisplayName
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName appopenuri
MaxLength 2000
RequiredLevel None
Type Memo

AppVersion

Property Value
Description The application version.
DisplayName
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName appversion
MaxLength 2000
RequiredLevel SystemRequired
Type Memo

AuthorizationReferences

Property Value
Description The authorization references of the application.
DisplayName
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName authorizationreferences
MaxLength 2000
RequiredLevel None
Type Memo

BackgroundColor

Property Value
Description The background image color.
DisplayName
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName backgroundcolor
MaxLength 2000
RequiredLevel None
Type Memo

BypassConsent

Property Value
Description Indicates whether the canvas app should bypass consent from consumers.
DisplayName Bypass Consent
IsValidForForm False
IsValidForRead True
LogicalName bypassconsent
RequiredLevel None
Type Boolean

BypassConsent Options

Value Label
1 True
0 False

DefaultValue: False

CanvasAppId

Property Value
Description For internal use only.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName canvasappid
RequiredLevel SystemRequired
Type Uniqueidentifier

CommitMessage

Property Value
Description The commit message of the app.
DisplayName The commit message.
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName commitmessage
MaxLength 2000
RequiredLevel None
Type Memo

ConnectionReferences

Property Value
Description The connection references of the application.
DisplayName
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName connectionreferences
MaxLength 768000
RequiredLevel None
Type Memo

CreatedByClientVersion

Property Value
Description The version of the client that was used to author the application.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyclientversion
MaxLength 100
RequiredLevel None
Type String

CreatedTime

Property Value
DateTimeBehavior UserLocal
Description Date and time when the application was created.
DisplayName Created Time
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdtime
RequiredLevel None
Type DateTime

Description

Property Value
Description The description of the app.
DisplayName The description.
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName description
MaxLength 2000
RequiredLevel None
Type Memo

DisplayName

Property Value
Description The display name of the app.
DisplayName
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName displayname
MaxLength 2000
RequiredLevel None
Type Memo

EmbeddedApp

Property Value
Description Internal use. The embedded app information.
DisplayName
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName embeddedapp
MaxLength 2000
RequiredLevel None
Type Memo

GalleryItemId

Property Value
Description The gallery item identifier.
DisplayName The gallery item identifier
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName galleryitemid
MaxLength 2000
RequiredLevel None
Type Memo

IntroducedVersion

Property Value
Description Version in which the canvas app is introduced.
DisplayName Introduced Version
FormatName VersionNumber
IsLocalizable False
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName introducedversion
MaxLength 48
RequiredLevel None
Type String

IsCdsUpgraded

Property Value
Description Indicates whether the canvas app contains CDS 1.0 references.
DisplayName Is CDS Upgraded
IsValidForForm False
IsValidForRead True
LogicalName iscdsupgraded
RequiredLevel None
Type Boolean

IsCdsUpgraded Options

Value Label
1 True
0 False

DefaultValue: False

IsFeaturedApp

Property Value
Description Indicates whether the canvas app is a featured app.
DisplayName Is Featured App
IsValidForForm False
IsValidForRead True
LogicalName isfeaturedapp
RequiredLevel None
Type Boolean

IsFeaturedApp Options

Value Label
1 True
0 False

DefaultValue: False

IsHeroApp

Property Value
Description Indicates whether the canvas app is a hero app.
DisplayName Is Hero App
IsValidForForm False
IsValidForRead True
LogicalName isheroapp
RequiredLevel None
Type Boolean

IsHeroApp Options

Value Label
1 True
0 False

DefaultValue: False

IsHidden

Property Value
Description Indicates whether the canvas app is hidden from a user's list.
DisplayName Is Hidden
IsValidForForm False
IsValidForRead True
LogicalName ishidden
RequiredLevel None
Type Boolean

IsHidden Options

Value Label
1 True
0 False

DefaultValue: False

LastModifiedTime

Property Value
DateTimeBehavior UserLocal
Description Date and time when the application was last modified.
DisplayName Last Modified Time
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName lastmodifiedtime
RequiredLevel None
Type DateTime

LastPublishTime

Property Value
DateTimeBehavior UserLocal
Description Date and time when the application was last published.
DisplayName Last Publish Time
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName lastpublishtime
RequiredLevel None
Type DateTime

MinClientVersion

Property Value
Description The version of the client that was used to author the application.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName minclientversion
MaxLength 100
RequiredLevel None
Type String

Name

Property Value
Description Name of the CanvasApp
DisplayName CanvasApp Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerId

Property Value
Description Unique identifier of the user or team who owns the canvas app.
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser
Type Owner

OwnerIdType

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

Publisher

Property Value
Description The publisher of the app.
DisplayName
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName publisher
MaxLength 2000
RequiredLevel None
Type Memo

Status

Property Value
Description A value indicating whether the application is ready for consumption.
DisplayName Status
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName status
MaxLength 2000
RequiredLevel None
Type Memo

Tags

Property Value
Description The metadata tags of the application.
DisplayName
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName tags
MaxLength 2000
RequiredLevel None
Type Memo

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

CanvasAppRowId

Property Value
Description For internal use only.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName canvasapprowid
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

ComponentState Options

Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

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

IsManaged Options

Value Label
1 Managed
0 Unmanaged

DefaultValue: False

OverwriteTime

Property Value
DateTimeBehavior UserLocal
Description For internal use only.
DisplayName Record Overwrite Time
Format DateOnly
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime

OwnerIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Property Value
Description Unique identifier of the business unit that owns the process.
DisplayName Owning Business Unit
IsValidForForm True
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningBusinessUnitName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunitname
MaxLength 100
RequiredLevel None
Type String

OwningTeam

Property Value
Description Unique identifier of the team who owns the process.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Property Value
Description Unique identifier of the user who owns the process.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

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
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

businessunit_canvasapp

See businessunit Entity businessunit_canvasapp One-To-Many relationship.

FK_CanvasApp_Solution

See solution Entity FK_CanvasApp_Solution One-To-Many relationship.

See also

About the Entity Reference
Programming reference for Dynamics 365 Customer Engagement
Web API Reference
Microsoft.Dynamics.CRM.canvasapp