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.
Messages
The following table lists the messages for the Setting (adx_setting) 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 |
|---|---|---|
AssignEvent: True |
PATCH /adx_settings(adx_settingid)Update the ownerid property. |
AssignRequest |
AssociateEvent: True |
Associate records | Associate records |
CreateEvent: True |
POST /adx_settingsSee Create |
Create records |
CreateMultipleEvent: True |
CreateMultiple | CreateMultipleRequest |
DeleteEvent: True |
DELETE /adx_settings(adx_settingid)See Delete |
Delete records |
DisassociateEvent: True |
Disassociate records | Disassociate records |
GrantAccessEvent: True |
GrantAccess | GrantAccessRequest |
IsValidStateTransitionEvent: False |
IsValidStateTransition | IsValidStateTransitionRequest |
ModifyAccessEvent: True |
ModifyAccess | ModifyAccessRequest |
RetrieveEvent: True |
GET /adx_settings(adx_settingid)See Retrieve |
Retrieve records |
RetrieveMultipleEvent: True |
GET /adx_settingsSee Query data |
Query data |
RetrievePrincipalAccessEvent: True |
RetrievePrincipalAccess | RetrievePrincipalAccessRequest |
RetrieveSharedPrincipalsAndAccessEvent: True |
RetrieveSharedPrincipalsAndAccess | RetrieveSharedPrincipalsAndAccessRequest |
RevokeAccessEvent: True |
RevokeAccess | RevokeAccessRequest |
SetStateEvent: True |
PATCH /adx_settings(adx_settingid)Update the statecode and statuscode properties. |
SetStateRequest |
UpdateEvent: True |
PATCH /adx_settings(adx_settingid)See Update |
Update records |
UpdateMultipleEvent: True |
UpdateMultiple | UpdateMultipleRequest |
UpsertEvent: False |
PATCH /adx_settings(adx_settingid)See Upsert a table row |
UpsertRequest |
UpsertMultipleEvent: False |
UpsertMultiple | UpsertMultipleRequest |
Events
The following table lists the events for the Setting (adx_setting) 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 Setting (adx_setting) table.
| Property | Value |
|---|---|
| DisplayName | Setting |
| DisplayCollectionName | Settings |
| SchemaName | adx_setting |
| CollectionSchemaName | adx_settings |
| EntitySetName | adx_settings |
| LogicalName | adx_setting |
| LogicalCollectionName | adx_settings |
| PrimaryIdAttribute | adx_settingid |
| PrimaryNameAttribute | adx_name |
| TableType | Standard |
| OwnershipType | UserOwned |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- adx_description
- adx_encryptedcontent
- adx_name
- adx_settingId
- adx_value
- ImportSequenceNumber
- OverriddenCreatedOn
- OwnerId
- OwnerIdType
- statecode
- statuscode
- TimeZoneRuleVersionNumber
- UTCConversionTimeZoneCode
adx_description
| Property | Value |
|---|---|
| Description | |
| DisplayName | Description |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | adx_description |
| RequiredLevel | None |
| Type | Memo |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 2000 |
adx_encryptedcontent
| Property | Value |
|---|---|
| Description | |
| DisplayName | Encrypted Content |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | adx_encryptedcontent |
| RequiredLevel | None |
| Type | Memo |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 1048000 |
adx_name
| Property | Value |
|---|---|
| Description | The name of the custom entity. |
| DisplayName | Name |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | adx_name |
| RequiredLevel | ApplicationRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
adx_settingId
| Property | Value |
|---|---|
| Description | Shows the entity instances. |
| DisplayName | Setting |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | adx_settingid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
adx_value
| Property | Value |
|---|---|
| Description | |
| DisplayName | Value |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | adx_value |
| RequiredLevel | None |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 4000 |
ImportSequenceNumber
| Property | Value |
|---|---|
| Description | Sequence number of the import that created this record. |
| DisplayName | Import Sequence Number |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | importsequencenumber |
| RequiredLevel | None |
| Type | Integer |
| MaxValue | 2147483647 |
| MinValue | -2147483648 |
OverriddenCreatedOn
| Property | Value |
|---|---|
| Description | Shows when the record was migrated. |
| DisplayName | Record Created On |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | overriddencreatedon |
| RequiredLevel | None |
| Type | DateTime |
| CanChangeDateTimeBehavior | False |
| DateTimeBehavior | UserLocal |
| Format | DateOnly |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
OwnerId
| Property | Value |
|---|---|
| Description | Owner Id |
| DisplayName | Owner |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | ownerid |
| RequiredLevel | SystemRequired |
| Type | Owner |
| Targets | systemuser, team |
OwnerIdType
| Property | Value |
|---|---|
| Description | Owner Id Type |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridtype |
| RequiredLevel | SystemRequired |
| Type | EntityName |
statecode
| Property | Value |
|---|---|
| Description | Status of the Setting |
| DisplayName | Status |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statecode |
| RequiredLevel | SystemRequired |
| Type | State |
| DefaultFormValue | |
| GlobalChoiceName | adx_setting_statecode |
statecode Choices/Options
| Value | Details |
|---|---|
| 0 | Label: Active DefaultStatus: 1 InvariantName: Active |
| 1 | Label: Inactive DefaultStatus: 2 InvariantName: Inactive |
statuscode
| Property | Value |
|---|---|
| Description | Select the Setting's status. |
| DisplayName | Status Reason |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statuscode |
| RequiredLevel | None |
| Type | Status |
| DefaultFormValue | |
| GlobalChoiceName | adx_setting_statuscode |
statuscode Choices/Options
| Value | Details |
|---|---|
| 1 | Label: Active State:0 TransitionData: None |
| 2 | Label: Inactive State:1 TransitionData: None |
TimeZoneRuleVersionNumber
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Time Zone Rule Version Number |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | timezoneruleversionnumber |
| RequiredLevel | None |
| Type | Integer |
| MaxValue | 2147483647 |
| MinValue | -1 |
UTCConversionTimeZoneCode
| Property | Value |
|---|---|
| Description | Shows the time zone code that was in use when the record was created. |
| DisplayName | UTC Conversion Time Zone Code |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | utcconversiontimezonecode |
| RequiredLevel | None |
| Type | Integer |
| MaxValue | 2147483647 |
| MinValue | -1 |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.
- CreatedBy
- CreatedOn
- CreatedOnBehalfBy
- ModifiedBy
- ModifiedOn
- ModifiedOnBehalfBy
- OwnerIdName
- OwnerIdYomiName
- OwningBusinessUnit
- OwningTeam
- OwningUser
- VersionNumber
CreatedBy
| Property | Value |
|---|---|
| Description | Shows the user who created the record. |
| DisplayName | Created By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
CreatedOn
| Property | Value |
|---|---|
| Description | Shows when the record was created. |
| DisplayName | Created On |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdon |
| RequiredLevel | None |
| Type | DateTime |
| CanChangeDateTimeBehavior | False |
| DateTimeBehavior | UserLocal |
| Format | DateAndTime |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
CreatedOnBehalfBy
| Property | Value |
|---|---|
| Description | Shows the delegate user who created the record. |
| DisplayName | Created By (Delegate) |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdonbehalfby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
ModifiedBy
| Property | Value |
|---|---|
| Description | Shows the user who modified the record. |
| DisplayName | Modified By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
ModifiedOn
| Property | Value |
|---|---|
| Description | Shows when the record was modified. |
| DisplayName | Modified On |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedon |
| RequiredLevel | None |
| Type | DateTime |
| CanChangeDateTimeBehavior | False |
| DateTimeBehavior | UserLocal |
| Format | DateAndTime |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
ModifiedOnBehalfBy
| Property | Value |
|---|---|
| Description | Shows the delegate user who modified the record. |
| DisplayName | Modified By (Delegate) |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
OwnerIdName
| Property | Value |
|---|---|
| Description | Name of the owner |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridname |
| RequiredLevel | SystemRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
OwnerIdYomiName
| Property | Value |
|---|---|
| Description | Yomi name of the owner |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridyominame |
| RequiredLevel | SystemRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
OwningBusinessUnit
| Property | Value |
|---|---|
| Description | Shows the business unit that owns the record. |
| DisplayName | Owning Business Unit |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | owningbusinessunit |
| RequiredLevel | None |
| Type | Lookup |
| Targets | businessunit |
OwningTeam
| Property | Value |
|---|---|
| Description | Unique identifier for the team that owns the record. |
| DisplayName | Owning Team |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owningteam |
| RequiredLevel | None |
| Type | Lookup |
| Targets | team |
OwningUser
| Property | Value |
|---|---|
| Description | Unique identifier for the user that owns the record. |
| DisplayName | Owning User |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owninguser |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
VersionNumber
| Property | Value |
|---|---|
| Description | Version Number |
| DisplayName | Version Number |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | versionnumber |
| RequiredLevel | None |
| Type | BigInt |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
Many-to-One relationships
These relationships are many-to-one. Listed by SchemaName.
- business_unit_adx_setting
- lk_adx_setting_createdby
- lk_adx_setting_createdonbehalfby
- lk_adx_setting_modifiedby
- lk_adx_setting_modifiedonbehalfby
- owner_adx_setting
- team_adx_setting
- user_adx_setting
business_unit_adx_setting
One-To-Many Relationship: businessunit business_unit_adx_setting
| Property | Value |
|---|---|
| ReferencedEntity | businessunit |
| ReferencedAttribute | businessunitid |
| ReferencingAttribute | owningbusinessunit |
| ReferencingEntityNavigationPropertyName | owningbusinessunit |
| IsHierarchical | |
| CascadeConfiguration | Archive: RestrictAssign: NoCascadeDelete: RestrictMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_adx_setting_createdby
One-To-Many Relationship: systemuser lk_adx_setting_createdby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | createdby |
| ReferencingEntityNavigationPropertyName | createdby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_adx_setting_createdonbehalfby
One-To-Many Relationship: systemuser lk_adx_setting_createdonbehalfby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | createdonbehalfby |
| ReferencingEntityNavigationPropertyName | createdonbehalfby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_adx_setting_modifiedby
One-To-Many Relationship: systemuser lk_adx_setting_modifiedby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | modifiedby |
| ReferencingEntityNavigationPropertyName | modifiedby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_adx_setting_modifiedonbehalfby
One-To-Many Relationship: systemuser lk_adx_setting_modifiedonbehalfby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | modifiedonbehalfby |
| ReferencingEntityNavigationPropertyName | modifiedonbehalfby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
owner_adx_setting
One-To-Many Relationship: owner owner_adx_setting
| Property | Value |
|---|---|
| ReferencedEntity | owner |
| ReferencedAttribute | ownerid |
| ReferencingAttribute | ownerid |
| ReferencingEntityNavigationPropertyName | ownerid |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
team_adx_setting
One-To-Many Relationship: team team_adx_setting
| Property | Value |
|---|---|
| ReferencedEntity | team |
| ReferencedAttribute | teamid |
| ReferencingAttribute | owningteam |
| ReferencingEntityNavigationPropertyName | owningteam |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
user_adx_setting
One-To-Many Relationship: systemuser user_adx_setting
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | owninguser |
| ReferencingEntityNavigationPropertyName | owninguser |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
One-to-Many relationships
These relationships are one-to-many. Listed by SchemaName.
- adx_setting_AsyncOperations
- adx_setting_BulkDeleteFailures
- adx_setting_MailboxTrackingFolders
- adx_setting_PrincipalObjectAttributeAccesses
- adx_setting_ProcessSession
- adx_setting_SyncErrors
adx_setting_AsyncOperations
Many-To-One Relationship: asyncoperation adx_setting_AsyncOperations
| Property | Value |
|---|---|
| ReferencingEntity | asyncoperation |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | adx_setting_AsyncOperations |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
adx_setting_BulkDeleteFailures
Many-To-One Relationship: bulkdeletefailure adx_setting_BulkDeleteFailures
| Property | Value |
|---|---|
| ReferencingEntity | bulkdeletefailure |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | adx_setting_BulkDeleteFailures |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
adx_setting_MailboxTrackingFolders
Many-To-One Relationship: mailboxtrackingfolder adx_setting_MailboxTrackingFolders
| Property | Value |
|---|---|
| ReferencingEntity | mailboxtrackingfolder |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | adx_setting_MailboxTrackingFolders |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
adx_setting_PrincipalObjectAttributeAccesses
Many-To-One Relationship: principalobjectattributeaccess adx_setting_PrincipalObjectAttributeAccesses
| Property | Value |
|---|---|
| ReferencingEntity | principalobjectattributeaccess |
| ReferencingAttribute | objectid |
| ReferencedEntityNavigationPropertyName | adx_setting_PrincipalObjectAttributeAccesses |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
adx_setting_ProcessSession
Many-To-One Relationship: processsession adx_setting_ProcessSession
| Property | Value |
|---|---|
| ReferencingEntity | processsession |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | adx_setting_ProcessSession |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
adx_setting_SyncErrors
Many-To-One Relationship: syncerror adx_setting_SyncErrors
| Property | Value |
|---|---|
| ReferencingEntity | syncerror |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | adx_setting_SyncErrors |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
See also
Dataverse table/entity reference
Dataverse Web API Reference
adx_setting