mspp_webfile EntityType

Storage of files used in the web Portals.

Entity Set Path
[organization URI]/api/data/v9.2/mspp_webfiles
Base Type
Display Name
Web File
Primary Key
Primary Key Attribute
Operations Supported


Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
mspp_alloworigin Edm.String

Defines CORS header Access-Control-Allow-Origin for cross origin requests.

Display Name: Allow Origin

mspp_cloudblobaddress Edm.String

Display Name: Cloud Blob Address

mspp_contentdisposition Edm.Int32

Shows the value to be applied to the HTTP Response Headers Content-Disposition.

Display Name: Content-Disposition

Default Options
Values Label
756150000 inline
756150001 attachment
mspp_createdbyipaddress Edm.String

Display Name: Created By IP Address

mspp_createdbyusername Edm.String

Display Name: Created By Username

mspp_createdon Edm.DateTimeOffset

Shows the date and time when the record was created.

Display Name: Created On

mspp_displaydate Edm.DateTimeOffset

Display Name: Display Date

mspp_displayorder Edm.Int32

Display Name: Display Order

mspp_excludefromsearch Edm.Boolean

Shows whether the web file is excluded from the portal search.

Display Name: Exclude From Search

Default Options
Values Label
1 Yes
0 No
mspp_expirationdate Edm.DateTimeOffset

Display Name: Expiration Date

mspp_hiddenfromsitemap Edm.Boolean

Display Name: Hidden From Sitemap

Default Options
Values Label
1 Yes
0 No
mspp_modifiedbyipaddress Edm.String

Display Name: Modified By IP Address

mspp_modifiedbyusername Edm.String

Display Name: Modified By Username

mspp_modifiedon Edm.DateTimeOffset

Shows the date and time when the record was modified.

Display Name: Modified On

mspp_name Edm.String

The name of the custom entity.

Display Name: Name

mspp_partialurl Edm.String

Display Name: Partial URL

mspp_releasedate Edm.DateTimeOffset

Display Name: Release Date

mspp_summary Edm.String

Display Name: Summary

mspp_title Edm.String

Display Name: Title

mspp_webfileid Edm.Guid

Unique identifier for entity instances

Display Name: Web File

statecode Edm.Int32

Status of the Web File

Display Name: Status

Default Options
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the Web File

Display Name: Status Reason

Default Options
Values Label
1 Active
2 Inactive

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
_mspp_createdby_value mspp_createdby

Shows who created the record.

_mspp_masterwebfileid_value mspp_masterwebfileid

Unique identifier for Web File associated with Web File.

_mspp_modifiedby_value mspp_modifiedby

Shows who last updated the record.

_mspp_parentpageid_value mspp_parentpageid

Unique identifier for Web Page associated with Web File.

_mspp_publishingstateid_value mspp_publishingstateid

Unique identifier for Publishing State associated with Web File.

_mspp_websiteid_value mspp_websiteid

Unique identifier for Website associated with Web File.

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
mspp_createdby systemuser mspp_systemuser_mspp_webfile_createdby
mspp_masterwebfileid mspp_webfile mspp_webfile_masterwebfile
mspp_modifiedby systemuser mspp_systemuser_mspp_webfile_modifiedby
mspp_parentpageid mspp_webpage mspp_webpage_webfile
mspp_publishingstateid mspp_publishingstate mspp_publishingstate_webfile
mspp_websiteid mspp_website mspp_website_webfile

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
mspp_webfile_masterwebfile mspp_webfile mspp_masterwebfileid
mspp_webfile_shortcut mspp_shortcut mspp_WebFileId
mspp_webfile_webpage_image mspp_webpage mspp_image


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

Name Binding
BulkRetain Not Bound
CreateMultiple Not Bound
PurgeRetainedContent Not Bound
Retain Not Bound
RollbackRetain Not Bound
UpdateMultiple Not Bound
ValidateRetentionConfig Not Bound

See also