webresource EntityType

Data equivalent to files used in Web development. Web resources provide client-side components that are used to provide custom user interface elements.

Entity set path:
[organization URI]/api/data/v9.2/webresourceset
Base type:
crmbaseentity
Display name:
Web Resource
Primary key:
webresourceid
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
canbedeleted BooleanManagedProperty

Information that specifies whether this component can be deleted.

Display name: Can Be Deleted

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
content Edm.String

Bytes of the web resource, in Base64 format.

content_binary Edm.Binary

Bytes of the web resource, in Base64 format.

contentfileref Edm.Binary

Reference to the content file on Azure.

Display name: ContentFileRef

Read only
contentfileref_name Edm.String
Read onlyy
contentjson Edm.String

Json representation of the content of the resource.

contentjsonfileref Edm.Binary

Reference to the Json content file on Azure.

Display name: ContentJsonFileRef

Read only
contentjsonfileref_name Edm.String
Read onlyy
createdon Edm.DateTimeOffset

Date and time when the web resource was created.

Display name: Created On

Read only
dependencyxml Edm.String

For internal use only.

Display name: DependencyXML

description Edm.String

Description of the web resource.

Display name: Description

displayname Edm.String

Display name of the web resource.

Display name: Display Name

introducedversion Edm.String

Version in which the form is introduced.

Display name: Introduced Version

isavailableformobileoffline Edm.Boolean

Information that specifies whether this web resource is available for mobile client in offline mode.

Display name: Is Available For Mobile Offline

Default options
Values Label
1 Yes
0 No
iscustomizable BooleanManagedProperty

Information that specifies whether this component can be customized.

Display name: Customizable

isenabledformobileclient Edm.Boolean

Information that specifies whether this web resource is enabled for mobile client.

Display name: Is Enabled For Mobile Client

Default options
Values Label
1 Yes
0 No
ishidden BooleanManagedProperty

Information that specifies whether this component should be hidden.

Display name: Hidden

ismanaged Edm.Boolean
Read onlyy
Default options
Values Label
1 Managed
0 Unmanaged
languagecode Edm.Int32

Language of the web resource.

Display name: Language

modifiedon Edm.DateTimeOffset

Date and time when the web resource was last modified.

Display name: Modified On

Read only
name Edm.String

Name of the web resource.

Display name: Name

overwritetime Edm.DateTimeOffset

For internal use only.

Display name: Record Overwrite Time

Read only
silverlightversion Edm.String

Silverlight runtime version number required by a silverlight web resource.

Display name: Silverlight Version

solutionid Edm.Guid

Unique identifier of the associated solution.

Display name: Solution

Read only
versionnumber Edm.Int64
Read onlyy
webresourceid Edm.Guid

Unique identifier of the web resource.

Display name: Web Resource Identifier

webresourceidunique Edm.Guid

For internal use only.

Read only
webresourcetype Edm.Int32

Drop-down list for selecting the type of the web resource.

Display name: Type

Default options
Values Label
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)

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
_createdby_value createdby

Unique identifier of the user who created the web resource.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the web resource.

_modifiedby_value modifiedby

Unique identifier of the user who last modified the web resource.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the web resource.

_organizationid_value organizationid

Unique identifier of the organization associated with the web resource.

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
ContentFileRef fileattachment FileAttachment_WebResource_ContentFileRef
ContentJsonFileRef fileattachment FileAttachment_WebResource_ContentJsonFileRef
createdby systemuser webresource_createdby
createdonbehalfby systemuser lk_webresourcebase_createdonbehalfby
modifiedby systemuser webresource_modifiedby
modifiedonbehalfby systemuser lk_webresourcebase_modifiedonbehalfby
organizationid organization webresource_organization

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
appactionrule_webresource_scripts appactionrule appactionrule_webresource_scripts
lk_theme_logoid theme logoimage
solution_configuration_webresource solution configurationpageid
webresource_appaction_iconwebresourceid appaction IconWebResourceId
webresource_appaction_onclickeventjavascriptwebresourceid appaction OnClickEventJavaScriptWebResourceId
webresource_FileAttachments fileattachment objectid_webresource
webresource_savedqueryvisualizations savedqueryvisualization webresourceid
webresource_userqueryvisualizations userqueryvisualization webresourceid

Operations

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

Name Binding
RetrieveUnpublished Bound to Entity
RetrieveUnpublishedMultiple Bound to Collection

See also