adx_setting EntityType
- Entity Set Path
- [organization URI]/api/data/v9.2/adx_settings
- Base Type
- crmbaseentity
- Display Name
- Setting
- Primary Key
- adx_settingid
- Primary Key Attribute
- adx_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 | ||||||
|---|---|---|---|---|---|---|---|---|
| adx_description | Edm.String |
Display Name: Description |
||||||
| adx_name | Edm.String |
The name of the custom entity. Display Name: Name |
||||||
| adx_settingid | Edm.Guid |
Shows the entity instances. Display Name: Setting |
||||||
| adx_value | Edm.String |
Display Name: Value |
||||||
| createdon | Edm.DateTimeOffset |
Shows when the record was created. Display Name: Created On Read Only
|
||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display Name: Import Sequence Number |
||||||
| modifiedon | Edm.DateTimeOffset |
Shows when the record was modified. Display Name: Modified On Read Only
|
||||||
| overriddencreatedon | Edm.DateTimeOffset |
Shows when the record was migrated. Display Name: Record Created On |
||||||
| statecode | Edm.Int32 |
Status of the Setting Display Name: Status
Default Options
|
||||||
| statuscode | Edm.Int32 |
Select the Setting's status. Display Name: Status Reason
Default Options
|
||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display Name: Time Zone Rule Version Number |
||||||
| utcconversiontimezonecode | Edm.Int32 |
Shows the time zone code that was in use when the record was created. Display Name: UTC Conversion Time Zone Code |
||||||
| versionnumber | Edm.Int64 |
Version Number Display Name: Version Number Read Only
|
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 |
|---|---|---|
| _createdby_value | createdby |
Shows the user who created the record. |
| _createdonbehalfby_value | createdonbehalfby |
Shows the delegate user who created the record. |
| _modifiedby_value | modifiedby |
Shows the user who modified the record. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Shows the delegate user who modified the record. |
| _ownerid_value | ownerid |
Owner Id |
| _owningbusinessunit_value | owningbusinessunit |
Shows the business unit that owns the record. |
| _owningteam_value | owningteam |
Unique identifier for the team that owns the record. |
| _owninguser_value | owninguser |
Unique identifier for the user that owns the record. |
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 |
|---|---|---|
| createdby | systemuser | lk_adx_setting_createdby |
| createdonbehalfby | systemuser | lk_adx_setting_createdonbehalfby |
| modifiedby | systemuser | lk_adx_setting_modifiedby |
| modifiedonbehalfby | systemuser | lk_adx_setting_modifiedonbehalfby |
| ownerid | principal | owner_adx_setting |
| owningbusinessunit | businessunit | business_unit_adx_setting |
| owningteam | team | team_adx_setting |
| owninguser | systemuser | user_adx_setting |
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 |
|---|---|---|
| adx_setting_AsyncOperations | asyncoperation | regardingobjectid_adx_setting |
| adx_setting_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_adx_setting |
| adx_setting_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_adx_setting |
| adx_setting_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_adx_setting |
| adx_setting_ProcessSession | processsession | regardingobjectid_adx_setting |
| adx_setting_SyncErrors | syncerror | regardingobjectid_adx_setting |
Operations
The following operations can be used with the adx_setting entity type.
| Name | Binding |
|---|---|
| BulkRetain | Not Bound |
| CreateMultiple | Not Bound |
| GrantAccess | Not Bound |
| IsValidStateTransition | Not Bound |
| ModifyAccess | Not Bound |
| PurgeRetainedContent | Not Bound |
| Retain | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
| RollbackRetain | Not Bound |
| UpdateMultiple | Not Bound |
| ValidateRetentionConfig | Not Bound |