Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Sets the user's role for the Portal.
Messages
The following table lists the messages for the Web Role (mspp_webrole) table. Messages represent operations that can be performed on the table. They may also be events.
| Name Is Event? |
Web API Operation | SDK for .NET |
|---|---|---|
AssociateEvent: True |
Associate records | Associate records |
CreateEvent: True |
POST /mspp_webrolesSee Create |
Create records |
CreateMultipleEvent: True |
CreateMultiple | CreateMultipleRequest |
DeleteEvent: True |
DELETE /mspp_webroles(mspp_webroleid)See Delete |
Delete records |
DisassociateEvent: True |
Disassociate records | Disassociate records |
RetrieveEvent: True |
GET /mspp_webroles(mspp_webroleid)See Retrieve |
Retrieve records |
RetrieveEntityChangesEvent: True |
RetrieveEntityChangesRequest | |
RetrieveMultipleEvent: True |
GET /mspp_webrolesSee Query data |
Query data |
UpdateEvent: True |
PATCH /mspp_webroles(mspp_webroleid)See Update |
Update records |
UpdateMultipleEvent: True |
UpdateMultiple | UpdateMultipleRequest |
UpsertEvent: False |
PATCH /mspp_webroles(mspp_webroleid)See Upsert a table row |
UpsertRequest |
UpsertMultipleEvent: False |
UpsertMultiple | UpsertMultipleRequest |
Events
The following table lists the events for the Web Role (mspp_webrole) table. Events are messages that exist so that you can subscribe to them. Unless you added the event, you shouldn't invoke the message, only subscribe to it.
| Name | Web API Operation | SDK for .NET |
|---|---|---|
BulkRetain |
BulkRetain | Learn to use messages with the SDK for .NET |
PurgeRetainedContent |
PurgeRetainedContent | Learn to use messages with the SDK for .NET |
Retain |
Retain | Learn to use messages with the SDK for .NET |
RollbackRetain |
RollbackRetain | Learn to use messages with the SDK for .NET |
ValidateRetentionConfig |
ValidateRetentionConfig | Learn to use messages with the SDK for .NET |
Properties
The following table lists selected properties for the Web Role (mspp_webrole) table.
| Property | Value |
|---|---|
| DisplayName | Web Role |
| DisplayCollectionName | Web Roles |
| SchemaName | mspp_webrole |
| CollectionSchemaName | mspp_webroles |
| EntitySetName | mspp_webroles |
| LogicalName | mspp_webrole |
| LogicalCollectionName | mspp_webroles |
| PrimaryIdAttribute | mspp_webroleid |
| PrimaryNameAttribute | mspp_name |
| TableType | Virtual |
| OwnershipType | OrganizationOwned |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- mspp_anonymoususersrole
- mspp_authenticatedusersrole
- mspp_createdby
- mspp_createdon
- mspp_description
- mspp_key
- mspp_modifiedby
- mspp_modifiedon
- mspp_name
- mspp_webroleId
- mspp_websiteid
- statecode
- statuscode
mspp_anonymoususersrole
| Property | Value |
|---|---|
| Description | |
| DisplayName | Anonymous Users Role |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_anonymoususersrole |
| RequiredLevel | None |
| Type | Boolean |
| GlobalChoiceName | mspp_webrole_mspp_anonymoususersrole |
| DefaultValue | False |
| True Label | Yes |
| False Label | No |
mspp_authenticatedusersrole
| Property | Value |
|---|---|
| Description | |
| DisplayName | Authenticated Users Role |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_authenticatedusersrole |
| RequiredLevel | None |
| Type | Boolean |
| GlobalChoiceName | mspp_webrole_mspp_authenticatedusersrole |
| DefaultValue | False |
| True Label | Yes |
| False Label | No |
mspp_createdby
| Property | Value |
|---|---|
| Description | Shows who created the record. |
| DisplayName | Created By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_createdby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
mspp_createdon
| Property | Value |
|---|---|
| Description | Shows the date and time when the record was created. |
| DisplayName | Created On |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_createdon |
| RequiredLevel | None |
| Type | DateTime |
| CanChangeDateTimeBehavior | True |
| DateTimeBehavior | UserLocal |
| Format | DateAndTime |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
mspp_description
| Property | Value |
|---|---|
| Description | |
| DisplayName | Description |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_description |
| RequiredLevel | None |
| Type | Memo |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 2000 |
mspp_key
| Property | Value |
|---|---|
| Description | An alternate key that is not intended to be localized to allow retrieval of a specific Web Role in workflows or code. |
| DisplayName | Key |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_key |
| RequiredLevel | None |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
mspp_modifiedby
| Property | Value |
|---|---|
| Description | Shows who last updated the record. |
| DisplayName | Modified By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_modifiedby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
mspp_modifiedon
| Property | Value |
|---|---|
| Description | Shows the date and time when the record was modified. |
| DisplayName | Modified On |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_modifiedon |
| RequiredLevel | None |
| Type | DateTime |
| CanChangeDateTimeBehavior | True |
| DateTimeBehavior | UserLocal |
| Format | DateAndTime |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
mspp_name
| Property | Value |
|---|---|
| Description | The name of the custom entity. |
| DisplayName | Name |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_name |
| RequiredLevel | ApplicationRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
mspp_webroleId
| Property | Value |
|---|---|
| Description | Unique identifier for entity instances |
| DisplayName | Web Role |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | mspp_webroleid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
mspp_websiteid
| Property | Value |
|---|---|
| Description | Unique identifier for Website associated with Web Role. |
| DisplayName | Website |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_websiteid |
| RequiredLevel | ApplicationRequired |
| Type | Lookup |
| Targets | mspp_website |
statecode
| Property | Value |
|---|---|
| Description | Status of the Web Role |
| DisplayName | Status |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statecode |
| RequiredLevel | SystemRequired |
| Type | State |
| DefaultFormValue | |
| GlobalChoiceName | mspp_webrole_statecode |
statecode Choices/Options
| Value | Details |
|---|---|
| 0 | Label: Active DefaultStatus: 1 InvariantName: Active |
| 1 | Label: Inactive DefaultStatus: 2 InvariantName: Inactive |
statuscode
| Property | Value |
|---|---|
| Description | Reason for the status of the Web Role |
| DisplayName | Status Reason |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statuscode |
| RequiredLevel | None |
| Type | Status |
| DefaultFormValue | |
| GlobalChoiceName | mspp_webrole_statuscode |
statuscode Choices/Options
| Value | Details |
|---|---|
| 1 | Label: Active State:0 TransitionData: None |
| 2 | Label: Inactive State:1 TransitionData: None |
Many-to-One relationships
These relationships are many-to-one. Listed by SchemaName.
mspp_systemuser_mspp_webrole_createdby
One-To-Many Relationship: systemuser mspp_systemuser_mspp_webrole_createdby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | mspp_createdby |
| ReferencingEntityNavigationPropertyName | mspp_createdby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
mspp_systemuser_mspp_webrole_modifiedby
One-To-Many Relationship: systemuser mspp_systemuser_mspp_webrole_modifiedby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | mspp_modifiedby |
| ReferencingEntityNavigationPropertyName | mspp_modifiedby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
mspp_website_webrole
One-To-Many Relationship: mspp_website mspp_website_webrole
| Property | Value |
|---|---|
| ReferencedEntity | mspp_website |
| ReferencedAttribute | mspp_websiteid |
| ReferencingAttribute | mspp_websiteid |
| ReferencingEntityNavigationPropertyName | mspp_websiteid |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
Many-to-Many relationships
These relationships are many-to-many. Listed by SchemaName.
- mspp_columnpermissionprofile_webrole
- mspp_entitypermission_webrole
- mspp_publishingstatetransitionrule_webrole
- mspp_webpageaccesscontrolrule_webrole
- mspp_websiteaccess_webrole
mspp_columnpermissionprofile_webrole
See mspp_columnpermissionprofile mspp_columnpermissionprofile_webrole Many-To-Many Relationship
| Property | Value |
|---|---|
| IntersectEntityName | mspp_columnpermissionprofile_webrole |
| IsCustomizable | False |
| SchemaName | mspp_columnpermissionprofile_webrole |
| IntersectAttribute | mspp_webroleid |
| NavigationPropertyName | mspp_columnpermissionprofile_webrole |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
mspp_entitypermission_webrole
See mspp_entitypermission mspp_entitypermission_webrole Many-To-Many Relationship
| Property | Value |
|---|---|
| IntersectEntityName | mspp_entitypermission_webrole |
| IsCustomizable | False |
| SchemaName | mspp_entitypermission_webrole |
| IntersectAttribute | mspp_webroleid |
| NavigationPropertyName | mspp_entitypermission_webrole |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
mspp_publishingstatetransitionrule_webrole
| Property | Value |
|---|---|
| IntersectEntityName | mspp_publishingstatetransitionrule_webrole |
| IsCustomizable | False |
| SchemaName | mspp_publishingstatetransitionrule_webrole |
| IntersectAttribute | mspp_webroleid |
| NavigationPropertyName | mspp_publishingstatetransitionrule_webrole |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
mspp_webpageaccesscontrolrule_webrole
See mspp_webpageaccesscontrolrule mspp_webpageaccesscontrolrule_webrole Many-To-Many Relationship
| Property | Value |
|---|---|
| IntersectEntityName | mspp_webpageaccesscontrolrule_webrole |
| IsCustomizable | False |
| SchemaName | mspp_webpageaccesscontrolrule_webrole |
| IntersectAttribute | mspp_webroleid |
| NavigationPropertyName | mspp_webpageaccesscontrolrule_webrole |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
mspp_websiteaccess_webrole
See mspp_websiteaccess mspp_websiteaccess_webrole Many-To-Many Relationship
| Property | Value |
|---|---|
| IntersectEntityName | mspp_websiteaccess_webrole |
| IsCustomizable | False |
| SchemaName | mspp_websiteaccess_webrole |
| IntersectAttribute | mspp_webroleid |
| NavigationPropertyName | mspp_websiteaccess_webrole |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
See also
Dataverse table/entity reference
Dataverse Web API Reference
mspp_webrole