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 searchrelationshipsettings 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 /searchrelationshipsettingsesSee Create |
Create records |
CreateMultipleEvent: True |
CreateMultiple | CreateMultipleRequest |
DeleteEvent: True |
DELETE /searchrelationshipsettingses(searchrelationshipsettingsid)See Delete |
Delete records |
DisassociateEvent: True |
Disassociate records | Disassociate records |
IsValidStateTransitionEvent: False |
IsValidStateTransition | IsValidStateTransitionRequest |
RetrieveEvent: True |
GET /searchrelationshipsettingses(searchrelationshipsettingsid)See Retrieve |
Retrieve records |
RetrieveMultipleEvent: True |
GET /searchrelationshipsettingsesSee Query data |
Query data |
SetStateEvent: True |
PATCH /searchrelationshipsettingses(searchrelationshipsettingsid)Update the statecode and statuscode properties. |
SetStateRequest |
UpdateEvent: True |
PATCH /searchrelationshipsettingses(searchrelationshipsettingsid)See Update |
Update records |
UpdateMultipleEvent: True |
UpdateMultiple | UpdateMultipleRequest |
UpsertEvent: False |
PATCH /searchrelationshipsettingses(searchrelationshipsettingsid)See Upsert a table row |
UpsertRequest |
UpsertMultipleEvent: False |
UpsertMultiple | UpsertMultipleRequest |
Events
The following table lists the events for the searchrelationshipsettings 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 searchrelationshipsettings table.
| Property | Value |
|---|---|
| DisplayName | SearchRelationshipSettings |
| DisplayCollectionName | SearchRelationshipSettings |
| SchemaName | searchrelationshipsettings |
| CollectionSchemaName | searchrelationshipsettingses |
| EntitySetName | searchrelationshipsettingses |
| LogicalName | searchrelationshipsettings |
| LogicalCollectionName | searchrelationshipsettingses |
| PrimaryIdAttribute | searchrelationshipsettingsid |
| PrimaryNameAttribute | relationshipsettingname |
| TableType | Standard |
| OwnershipType | OrganizationOwned |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- ImportSequenceNumber
- OverriddenCreatedOn
- RelationshipMetadataId
- RelationshipName
- relationshipsettingname
- SearchEntity
- searchrelationshipsettingsId
- statecode
- statuscode
- TimeZoneRuleVersionNumber
- UTCConversionTimeZoneCode
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 | Date and time that 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 |
RelationshipMetadataId
| Property | Value |
|---|---|
| Description | |
| DisplayName | RelationshipMetadataId |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | relationshipmetadataid |
| RequiredLevel | ApplicationRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
RelationshipName
| Property | Value |
|---|---|
| Description | |
| DisplayName | RelationshipName |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | relationshipname |
| RequiredLevel | ApplicationRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
relationshipsettingname
| Property | Value |
|---|---|
| Description | The name of the custom entity. |
| DisplayName | RelationshipSettingName |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | relationshipsettingname |
| RequiredLevel | None |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
SearchEntity
| Property | Value |
|---|---|
| Description | |
| DisplayName | SearchEntity |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | searchentity |
| RequiredLevel | ApplicationRequired |
| Type | Picklist |
| DefaultFormValue | -1 |
| GlobalChoiceName | searchentity |
SearchEntity Choices/Options
| Value | Label |
|---|---|
| 200004747 | Entity1 |
| 200004748 | Entity2 |
| 200004749 | ReferencedEntity |
searchrelationshipsettingsId
| Property | Value |
|---|---|
| Description | Unique identifier for entity instances |
| DisplayName | SearchRelationshipSettings |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | searchrelationshipsettingsid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
statecode
| Property | Value |
|---|---|
| Description | Status of the SearchRelationshipSettings |
| DisplayName | Status |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statecode |
| RequiredLevel | SystemRequired |
| Type | State |
| DefaultFormValue | |
| GlobalChoiceName | searchrelationshipsettings_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 SearchRelationshipSettings |
| DisplayName | Status Reason |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statuscode |
| RequiredLevel | None |
| Type | Status |
| DefaultFormValue | |
| GlobalChoiceName | searchrelationshipsettings_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 | 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
- OrganizationId
- VersionNumber
CreatedBy
| Property | Value |
|---|---|
| Description | Unique identifier of 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 | Date and time 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 | Unique identifier of 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 | Unique identifier of 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 | Date and time 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 | Unique identifier of the delegate user who modified the record. |
| DisplayName | Modified By (Delegate) |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
OrganizationId
| Property | Value |
|---|---|
| Description | Unique identifier for the organization |
| DisplayName | Organization Id |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | organizationid |
| RequiredLevel | None |
| Type | Lookup |
| Targets | organization |
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.
- lk_searchrelationshipsettings_createdby
- lk_searchrelationshipsettings_createdonbehalfby
- lk_searchrelationshipsettings_modifiedby
- lk_searchrelationshipsettings_modifiedonbehalfby
- organization_searchrelationshipsettings
lk_searchrelationshipsettings_createdby
One-To-Many Relationship: systemuser lk_searchrelationshipsettings_createdby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | createdby |
| ReferencingEntityNavigationPropertyName | createdby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_searchrelationshipsettings_createdonbehalfby
One-To-Many Relationship: systemuser lk_searchrelationshipsettings_createdonbehalfby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | createdonbehalfby |
| ReferencingEntityNavigationPropertyName | createdonbehalfby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_searchrelationshipsettings_modifiedby
One-To-Many Relationship: systemuser lk_searchrelationshipsettings_modifiedby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | modifiedby |
| ReferencingEntityNavigationPropertyName | modifiedby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_searchrelationshipsettings_modifiedonbehalfby
One-To-Many Relationship: systemuser lk_searchrelationshipsettings_modifiedonbehalfby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | modifiedonbehalfby |
| ReferencingEntityNavigationPropertyName | modifiedonbehalfby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
organization_searchrelationshipsettings
One-To-Many Relationship: organization organization_searchrelationshipsettings
| Property | Value |
|---|---|
| ReferencedEntity | organization |
| ReferencedAttribute | organizationid |
| ReferencingAttribute | organizationid |
| ReferencingEntityNavigationPropertyName | organizationid |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
One-to-Many relationships
These relationships are one-to-many. Listed by SchemaName.
- searchrelationshipsettings_AsyncOperations
- searchrelationshipsettings_BulkDeleteFailures
- searchrelationshipsettings_DuplicateBaseRecord
- searchrelationshipsettings_DuplicateMatchingRecord
- searchrelationshipsettings_MailboxTrackingFolders
- searchrelationshipsettings_PrincipalObjectAttributeAccesses
- searchrelationshipsettings_ProcessSession
- searchrelationshipsettings_SyncErrors
searchrelationshipsettings_AsyncOperations
Many-To-One Relationship: asyncoperation searchrelationshipsettings_AsyncOperations
| Property | Value |
|---|---|
| ReferencingEntity | asyncoperation |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | searchrelationshipsettings_AsyncOperations |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
searchrelationshipsettings_BulkDeleteFailures
Many-To-One Relationship: bulkdeletefailure searchrelationshipsettings_BulkDeleteFailures
| Property | Value |
|---|---|
| ReferencingEntity | bulkdeletefailure |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | searchrelationshipsettings_BulkDeleteFailures |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
searchrelationshipsettings_DuplicateBaseRecord
Many-To-One Relationship: duplicaterecord searchrelationshipsettings_DuplicateBaseRecord
| Property | Value |
|---|---|
| ReferencingEntity | duplicaterecord |
| ReferencingAttribute | baserecordid |
| ReferencedEntityNavigationPropertyName | searchrelationshipsettings_DuplicateBaseRecord |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
searchrelationshipsettings_DuplicateMatchingRecord
Many-To-One Relationship: duplicaterecord searchrelationshipsettings_DuplicateMatchingRecord
| Property | Value |
|---|---|
| ReferencingEntity | duplicaterecord |
| ReferencingAttribute | duplicaterecordid |
| ReferencedEntityNavigationPropertyName | searchrelationshipsettings_DuplicateMatchingRecord |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
searchrelationshipsettings_MailboxTrackingFolders
Many-To-One Relationship: mailboxtrackingfolder searchrelationshipsettings_MailboxTrackingFolders
| Property | Value |
|---|---|
| ReferencingEntity | mailboxtrackingfolder |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | searchrelationshipsettings_MailboxTrackingFolders |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
searchrelationshipsettings_PrincipalObjectAttributeAccesses
Many-To-One Relationship: principalobjectattributeaccess searchrelationshipsettings_PrincipalObjectAttributeAccesses
| Property | Value |
|---|---|
| ReferencingEntity | principalobjectattributeaccess |
| ReferencingAttribute | objectid |
| ReferencedEntityNavigationPropertyName | searchrelationshipsettings_PrincipalObjectAttributeAccesses |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
searchrelationshipsettings_ProcessSession
Many-To-One Relationship: processsession searchrelationshipsettings_ProcessSession
| Property | Value |
|---|---|
| ReferencingEntity | processsession |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | searchrelationshipsettings_ProcessSession |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
searchrelationshipsettings_SyncErrors
Many-To-One Relationship: syncerror searchrelationshipsettings_SyncErrors
| Property | Value |
|---|---|
| ReferencingEntity | syncerror |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | searchrelationshipsettings_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
searchrelationshipsettings