mspp_weblink EntityType

A textual or imaged based link to an interal or external URL.

Entity Set Path
[organization URI]/api/data/v9.2/mspp_weblinks
Base Type
Display Name
Web Link
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_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_description Edm.String

Display Name: Description

mspp_disablepagevalidation Edm.Boolean

Display Name: Disable Page Validation

Default Options
Values Label
1 Yes
0 No
mspp_displayimageonly Edm.Boolean

Display Name: Display Image Only

Default Options
Values Label
1 Yes
0 No
mspp_displayorder Edm.Int32

Display Name: Display Order

mspp_displaypagechildlinks Edm.Boolean

Select whether to display the children of the page as child links for this link.

Display Name: Display Page Child Links

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

Display Name: External Url

mspp_imagealttext Edm.String

Display Name: Image Alt Text

mspp_imageheight Edm.Int32

Display Name: Image Height

mspp_imageurl Edm.String

Display Name: Image Url

mspp_imagewidth Edm.Int32

Display Name: Image Width

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_openinnewwindow Edm.Boolean

Display Name: Open In New Window

Default Options
Values Label
1 Yes
0 No
mspp_robotsfollowlink Edm.Boolean

Display Name: Robots Follow Link

Default Options
Values Label
1 Yes
0 No
mspp_weblinkid Edm.Guid

Unique identifier for entity instances

Display Name: Web Link

statecode Edm.Int32

Status of the Web Link

Display Name: Status

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

Reason for the status of the Web Link

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_modifiedby_value mspp_modifiedby

Shows who last updated the record.

_mspp_pageid_value mspp_pageid

Unique identifier for Web Page associated with Web Link.

_mspp_parentweblinkid_value mspp_parentweblinkid

Unique identifier for parent Web Link associated with Web Link.

_mspp_publishingstateid_value mspp_publishingstateid

Unique identifier for Publishing State associated with Web Link.

_mspp_weblinksetid_value mspp_weblinksetid

Unique identifier for Web Link Set associated with Web Link.

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_weblink_createdby
mspp_modifiedby systemuser mspp_systemuser_mspp_weblink_modifiedby
mspp_pageid mspp_webpage mspp_webpage_weblink
mspp_parentweblinkid mspp_weblink mspp_weblink_weblink
mspp_publishingstateid mspp_publishingstate mspp_publishingstate_weblink
mspp_weblinksetid mspp_weblinkset mspp_weblinkset_weblink

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_weblink_weblink mspp_weblink mspp_parentweblinkid


The following operations can be used with the mspp_weblink 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