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:
- crmbaseentity
- Display name:
- Web Link
- Primary key:
- mspp_weblinkid
- Primary key attribute:
- mspp_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 | ||||||
|---|---|---|---|---|---|---|---|---|
| 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
|
||||||
| mspp_displayimageonly | Edm.Boolean |
Display name: Display Image Only
Default options
|
||||||
| 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
|
||||||
| 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
|
||||||
| mspp_robotsfollowlink | Edm.Boolean |
Display name: Robots Follow Link
Default options
|
||||||
| 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
|
||||||
| statuscode | Edm.Int32 |
Reason for the status of the Web Link Display name: Status Reason
Default options
|
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 |
Operations
The following operations can be used with the mspp_weblink entity type.
| Name | Binding |
|---|---|
| BulkRetain | Not Bound |
| CreateMultiple | Not Bound |
| DeleteMultiple | Not Bound |
| PurgeRetainedContent | Not Bound |
| Retain | Not Bound |
| RollbackRetain | Not Bound |
| UpdateMultiple | Not Bound |
| ValidateRetentionConfig | Not Bound |