WebResource entity reference
Data equivalent to files used in Web development. Web resources provide client-side components that are used to provide custom user interface elements.
Messages
Message | SDK class or method |
---|---|
Create | CreateRequest or Create |
Delete | DeleteRequest or Delete |
Retrieve | RetrieveRequest or Retrieve |
RetrieveMultiple | RetrieveMultipleRequest or RetrieveMultiple |
RetrieveUnpublished | RetrieveUnpublishedRequest |
RetrieveUnpublishedMultiple | RetrieveUnpublishedMultipleRequest |
Update | UpdateRequest or Update |
Properties
Property | Value |
---|---|
CollectionSchemaName | WebResources |
DisplayCollectionName | Web Resources |
DisplayName | Web Resource |
EntitySetName | webresourceset |
IsBPFEntity | False |
LogicalCollectionName | webresources |
LogicalName | webresource |
OwnershipType | OrganizationOwned |
PrimaryIdAttribute | webresourceid |
PrimaryNameAttribute | name |
SchemaName | WebResource |
Writable attributes
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- CanBeDeleted
- Content
- ContentJson
- DependencyXml
- Description
- DisplayName
- IntroducedVersion
- IsAvailableForMobileOffline
- IsCustomizable
- IsEnabledForMobileClient
- IsHidden
- LanguageCode
- Name
- SilverlightVersion
- WebResourceId
- WebResourceType
CanBeDeleted
Property | Value |
---|---|
Description | Information that specifies whether this component can be deleted. |
DisplayName | Can Be Deleted |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | canbedeleted |
RequiredLevel | SystemRequired |
Type | ManagedProperty |
Content
Property | Value |
---|---|
Description | Bytes of the web resource, in Base64 format. |
DisplayName | |
FormatName | TextArea |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | content |
MaxLength | 1073741823 |
RequiredLevel | None |
Type | String |
ContentJson
Property | Value |
---|---|
Description | Json representation of the content of the resource. |
DisplayName | |
Format | TextArea |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | contentjson |
MaxLength | 1073741823 |
RequiredLevel | None |
Type | Memo |
DependencyXml
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | DependencyXML |
Format | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | dependencyxml |
MaxLength | 5000 |
RequiredLevel | None |
Type | Memo |
Description
Property | Value |
---|---|
Description | Description of the web resource. |
DisplayName | Description |
Format | TextArea |
IsLocalizable | True |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | description |
MaxLength | 2000 |
RequiredLevel | None |
Type | Memo |
DisplayName
Property | Value |
---|---|
Description | Display name of the web resource. |
DisplayName | Display Name |
FormatName | Text |
IsLocalizable | True |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | displayname |
MaxLength | 200 |
RequiredLevel | None |
Type | String |
IntroducedVersion
Property | Value |
---|---|
Description | Version in which the form is introduced. |
DisplayName | Introduced Version |
FormatName | VersionNumber |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | introducedversion |
MaxLength | 48 |
RequiredLevel | None |
Type | String |
IsAvailableForMobileOffline
Property | Value |
---|---|
Description | Information that specifies whether this web resource is available for mobile client in offline mode. |
DisplayName | Is Available For Mobile Offline |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | isavailableformobileoffline |
RequiredLevel | SystemRequired |
Type | Boolean |
IsAvailableForMobileOffline Choices/Options
Value | Label | Description |
---|---|---|
1 | Yes | |
0 | No |
DefaultValue: 0
IsCustomizable
Property | Value |
---|---|
Description | Information that specifies whether this component can be customized. |
DisplayName | Customizable |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | iscustomizable |
RequiredLevel | SystemRequired |
Type | ManagedProperty |
IsEnabledForMobileClient
Property | Value |
---|---|
Description | Information that specifies whether this web resource is enabled for mobile client. |
DisplayName | Is Enabled For Mobile Client |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | isenabledformobileclient |
RequiredLevel | SystemRequired |
Type | Boolean |
IsEnabledForMobileClient Choices/Options
Value | Label | Description |
---|---|---|
1 | Yes | |
0 | No |
DefaultValue: 0
IsHidden
Property | Value |
---|---|
Description | Information that specifies whether this component should be hidden. |
DisplayName | Hidden |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | ishidden |
RequiredLevel | SystemRequired |
Type | ManagedProperty |
LanguageCode
Property | Value |
---|---|
Description | Language of the web resource. |
DisplayName | Language |
Format | Language |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | languagecode |
MaxValue | 2147483647 |
MinValue | 0 |
RequiredLevel | None |
Type | Integer |
Name
Property | Value |
---|---|
Description | Name of the web resource. |
DisplayName | Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | name |
MaxLength | 256 |
RequiredLevel | SystemRequired |
Type | String |
SilverlightVersion
Property | Value |
---|---|
Description | Silverlight runtime version number required by a silverlight web resource. |
DisplayName | Silverlight Version |
FormatName | Text |
IsLocalizable | True |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | silverlightversion |
MaxLength | 20 |
RequiredLevel | None |
Type | String |
WebResourceId
Property | Value |
---|---|
Description | Unique identifier of the web resource. |
DisplayName | Web Resource Identifier |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | webresourceid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
WebResourceType
Property | Value |
---|---|
Description | Drop-down list for selecting the type of the web resource. |
DisplayName | Type |
IsValidForForm | True |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | webresourcetype |
RequiredLevel | SystemRequired |
Type | Picklist |
WebResourceType Choices/Options
Value | Label | Description |
---|---|---|
1 | Webpage (HTML) | |
2 | Style Sheet (CSS) | |
3 | Script (JScript) | |
4 | Data (XML) | |
5 | PNG format | |
6 | JPG format | |
7 | GIF format | |
8 | Silverlight (XAP) | |
9 | Style Sheet (XSL) | |
10 | ICO format | |
11 | Vector format (SVG) | |
12 | String (RESX) |
Read-only attributes
These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- ComponentState
- CreatedBy
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- IsManaged
- ModifiedBy
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OrganizationId
- OrganizationIdName
- OverwriteTime
- SolutionId
- SupportingSolutionId
- VersionNumber
- WebResourceIdUnique
ComponentState
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Component State |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | componentstate |
RequiredLevel | SystemRequired |
Type | Picklist |
ComponentState Choices/Options
Value | Label | Description |
---|---|---|
0 | Published | |
1 | Unpublished | |
2 | Deleted | |
3 | Deleted Unpublished |
CreatedBy
Property | Value |
---|---|
Description | Unique identifier of the user who created the web resource. |
DisplayName | Created By |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | createdby |
RequiredLevel | None |
Targets | systemuser |
Type | Lookup |
CreatedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time when the web resource 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 web resource. |
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 |
IsManaged
Property | Value |
---|---|
Description | |
DisplayName | |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | ismanaged |
RequiredLevel | SystemRequired |
Type | Boolean |
IsManaged Choices/Options
Value | Label | Description |
---|---|---|
1 | Managed | |
0 | Unmanaged |
DefaultValue: 0
ModifiedBy
Property | Value |
---|---|
Description | Unique identifier of the user who last modified the web resource. |
DisplayName | Modified By |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedby |
RequiredLevel | None |
Targets | systemuser |
Type | Lookup |
ModifiedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time when the web resource was last modified. |
DisplayName | Modified On |
Format | DateAndTime |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedon |
RequiredLevel | None |
Type | DateTime |
ModifiedOnBehalfBy
Property | Value |
---|---|
Description | Unique identifier of the delegate user who modified the web resource. |
DisplayName | Created 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 web resource. |
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 |
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 |
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 |
WebResourceIdUnique
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | webresourceidunique |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
One-To-Many Relationships
Listed by SchemaName.
- webresource_savedqueryvisualizations
- solution_configuration_webresource
- webresource_userqueryvisualizations
- lk_theme_logoid
webresource_savedqueryvisualizations
Same as the webresource_savedqueryvisualizations many-to-one relationship for the savedqueryvisualization entity.
Property | Value |
---|---|
ReferencingEntity | savedqueryvisualization |
ReferencingAttribute | webresourceid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | webresource_savedqueryvisualizations |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
solution_configuration_webresource
Same as the solution_configuration_webresource many-to-one relationship for the solution entity.
Property | Value |
---|---|
ReferencingEntity | solution |
ReferencingAttribute | configurationpageid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | solution_configuration_webresource |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
webresource_userqueryvisualizations
Same as the webresource_userqueryvisualizations many-to-one relationship for the userqueryvisualization entity.
Property | Value |
---|---|
ReferencingEntity | userqueryvisualization |
ReferencingAttribute | webresourceid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | webresource_userqueryvisualizations |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
lk_theme_logoid
Same as the lk_theme_logoid many-to-one relationship for the theme entity.
Property | Value |
---|---|
ReferencingEntity | theme |
ReferencingAttribute | logoid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | lk_theme_logoid |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Restrict 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_webresourcebase_modifiedonbehalfby
- webresource_createdby
- lk_webresourcebase_createdonbehalfby
- webresource_modifiedby
- webresource_organization
lk_webresourcebase_modifiedonbehalfby
See the lk_webresourcebase_modifiedonbehalfby one-to-many relationship for the systemuser entity.
webresource_createdby
See the webresource_createdby one-to-many relationship for the systemuser entity.
lk_webresourcebase_createdonbehalfby
See the lk_webresourcebase_createdonbehalfby one-to-many relationship for the systemuser entity.
webresource_modifiedby
See the webresource_modifiedby one-to-many relationship for the systemuser entity.
webresource_organization
See the webresource_organization one-to-many relationship for the organization entity.