Solution Entity Reference

A solution which contains CRM customizations.

Messages

Message Web API Operation SDK Assembly
CloneAsPatch CloneAsPatch Action CloneAsPatchRequest
CloneAsSolution CloneAsSolution Action CloneAsSolutionRequest
Create POST [org URI]/api/data/v9.0/solutions
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/solutions(solutionid)
See Delete
DeleteRequest or
Delete
DeleteAndPromote DeleteAndPromote Action DeleteAndPromoteRequest
Retrieve GET [org URI]/api/data/v9.0/solutions(solutionid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/solutions
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
Update PATCH [org URI]/api/data/v9.0/solutions(solutionid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName Solutions
DisplayCollectionName Solutions
DisplayName Solution
EntitySetName solutions
IsBPFEntity False
LogicalCollectionName solutions
LogicalName solution
OwnershipType OrganizationOwned
PrimaryIdAttribute solutionid
PrimaryNameAttribute friendlyname
SchemaName Solution

Writable attributes

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

ConfigurationPageId

Property Value
Description A link to an optional configuration page for this solution.
DisplayName Configuration Page
IsValidForForm True
IsValidForRead True
LogicalName configurationpageid
RequiredLevel None
Targets webresource
Type Lookup

Description

Property Value
Description Description of the solution.
DisplayName Description
FormatName TextArea
IsLocalizable True
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 2000
RequiredLevel None
Type String

FriendlyName

Property Value
Description User display name for the solution.
DisplayName Display Name
FormatName Text
IsLocalizable True
IsValidForForm True
IsValidForRead True
LogicalName friendlyname
MaxLength 256
RequiredLevel SystemRequired
Type String

PublisherId

Property Value
Description Unique identifier of the publisher.
DisplayName Publisher
IsValidForForm True
IsValidForRead True
LogicalName publisherid
RequiredLevel SystemRequired
Targets publisher
Type Lookup

SolutionId

Property Value
Description Unique identifier of the solution.
DisplayName Solution Identifier
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

SolutionPackageVersion

Property Value
Description Solution package source organization version
DisplayName Solution Package Version
FormatName VersionNumber
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName solutionpackageversion
MaxLength 256
RequiredLevel None
Type String

SolutionType

Property Value
Description Solution Type
DisplayName Solution Type
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName solutiontype
RequiredLevel None
Type Picklist

SolutionType Options

Value Label
0 None
1 Snapshot
2 Internal

UniqueName

Property Value
Description The unique name of this solution
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName uniquename
MaxLength 65
RequiredLevel SystemRequired
Type String

Version

Property Value
Description Solution version, used to identify a solution for upgrades and hotfixes.
DisplayName Version
FormatName VersionNumber
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName version
MaxLength 256
RequiredLevel SystemRequired
Type String

Read-only attributes

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

ConfigurationPageIdName

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

CreatedBy

Property Value
Description Unique identifier of the user who created the solution.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

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

CreatedOn

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

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the solution.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

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

CreatedOnBehalfByYomiName

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

InstalledOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the solution was installed/upgraded.
DisplayName Installed On
Format DateOnly
IsValidForForm False
IsValidForRead True
LogicalName installedon
RequiredLevel None
Type DateTime

IsInternal

Property Value
Description Indicates whether the solution is internal or not.
DisplayName Is internal solution
IsValidForForm False
IsValidForRead False
LogicalName isinternal
RequiredLevel None
Type Boolean

IsInternal Options

Value Label
1 Yes
0 No

DefaultValue: False

IsManaged

Property Value
Description Indicates whether the solution is managed or unmanaged.
DisplayName Package Type
IsValidForForm True
IsValidForRead True
LogicalName ismanaged
RequiredLevel None
Type Boolean

IsManaged Options

Value Label
1 Managed
0 Unmanaged

DefaultValue: False

IsVisible

Property Value
Description Indicates whether the solution is visible outside of the platform.
DisplayName Is Visible Outside Platform
IsValidForForm False
IsValidForRead True
LogicalName isvisible
RequiredLevel None
Type Boolean

IsVisible Options

Value Label
1 Yes
0 No

DefaultValue: True

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the solution.
DisplayName Modified By
IsValidForForm False
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

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

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the solution was last modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who modified the solution.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

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

ModifiedOnBehalfByYomiName

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

OrganizationId

Property Value
Description Unique identifier of the organization associated with the solution.
DisplayName Organization
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Targets organization
Type Lookup

OrganizationIdName

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

ParentSolutionId

Property Value
Description Unique identifier of the parent solution. Should only be non-null if this solution is a patch.
DisplayName Parent Solution
IsValidForForm True
IsValidForRead True
LogicalName parentsolutionid
RequiredLevel None
Targets solution
Type Lookup

ParentSolutionIdName

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

PinpointAssetId

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

PinpointPublisherId

Property Value
Description Identifier of the publisher of this solution in Microsoft Pinpoint.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName pinpointpublisherid
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

PinpointSolutionDefaultLocale

Property Value
Description Default locale of the solution in Microsoft Pinpoint.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName pinpointsolutiondefaultlocale
MaxLength 16
RequiredLevel None
Type String

PinpointSolutionId

Property Value
Description Identifier of the solution in Microsoft Pinpoint.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName pinpointsolutionid
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

PublisherIdName

Property Value
Description name of the publisher.
DisplayName Publisher
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName publisheridname
MaxLength 100
RequiredLevel None
Type String

PublisherIdOptionValuePrefix

Property Value
Description
DisplayName
Format None
IsValidForForm False
IsValidForRead True
LogicalName publisheridoptionvalueprefix
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

PublisherIdPrefix

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

UpdatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the solution was updated.
DisplayName Updated On
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName updatedon
RequiredLevel None
Type DateTime

VersionNumber

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

FK_CanvasApp_Solution

Same as canvasapp entity FK_CanvasApp_Solution Many-To-One relationship.

Property Value
ReferencingEntity canvasapp
ReferencingAttribute solutionid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName FK_CanvasApp_Solution
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

solution_fieldpermission

Same as fieldpermission entity solution_fieldpermission Many-To-One relationship.

Property Value
ReferencingEntity fieldpermission
ReferencingAttribute solutionid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName solution_fieldpermission
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

solution_solutioncomponent

Same as solutioncomponent entity solution_solutioncomponent Many-To-One relationship.

Property Value
ReferencingEntity solutioncomponent
ReferencingAttribute solutionid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName solution_solutioncomponent
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

solution_parent_solution

Same as solution entity solution_parent_solution Many-To-One relationship.

Property Value
ReferencingEntity solution
ReferencingAttribute parentsolutionid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName solution_parent_solution
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Restrict
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

solution_role

Same as role entity solution_role Many-To-One relationship.

Property Value
ReferencingEntity role
ReferencingAttribute solutionid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName solution_role
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Solution_SyncErrors

Same as syncerror entity Solution_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Solution_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

solution_fieldsecurityprofile

Same as fieldsecurityprofile entity solution_fieldsecurityprofile Many-To-One relationship.

Property Value
ReferencingEntity fieldsecurityprofile
ReferencingAttribute solutionid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName solution_fieldsecurityprofile
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

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.

lk_solution_createdby

See systemuser Entity lk_solution_createdby One-To-Many relationship.

lk_solution_modifiedby

See systemuser Entity lk_solution_modifiedby One-To-Many relationship.

solution_parent_solution

See solution Entity solution_parent_solution One-To-Many relationship.

solution_configuration_webresource

See webresource Entity solution_configuration_webresource One-To-Many relationship.

lk_solutionbase_modifiedonbehalfby

See systemuser Entity lk_solutionbase_modifiedonbehalfby One-To-Many relationship.

organization_solution

See organization Entity organization_solution One-To-Many relationship.

lk_solutionbase_createdonbehalfby

See systemuser Entity lk_solutionbase_createdonbehalfby One-To-Many relationship.

publisher_solution

See publisher Entity publisher_solution One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
solution EntityType