searchrelationshipsettings EntityType
- Entity set path:
- [organization URI]/api/data/v9.2/searchrelationshipsettingses
- Base type:
- crmbaseentity
- Table type:
- Standard
- Display name:
- SearchRelationshipSettings
- Primary key:
- searchrelationshipsettingsid
- Primary name column:
- relationshipsettingname
- Operations supported:
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| createdon | Edm.DateTimeOffset |
Date and time 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 |
Date and time when the record was modified. Display name: Modified On Read only
|
||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
||||||||
| relationshipmetadataid | Edm.String |
Display name: RelationshipMetadataId |
||||||||
| relationshipname | Edm.String |
Display name: RelationshipName |
||||||||
| relationshipsettingname | Edm.String |
The name of the custom entity. Display name: RelationshipSettingName |
||||||||
| searchentity | Edm.Int32 |
Display name: SearchEntity
Default options
|
||||||||
| searchrelationshipsettingsid | Edm.Guid |
Unique identifier for entity instances Display name: SearchRelationshipSettings |
||||||||
| statecode | Edm.Int32 |
Status of the SearchRelationshipSettings Display name: Status
Default options
|
||||||||
| statuscode | Edm.Int32 |
Reason for the status of the SearchRelationshipSettings Display name: Status Reason
Default options
|
||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display name: Time Zone Rule Version Number |
||||||||
| utcconversiontimezonecode | Edm.Int32 |
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 |
Unique identifier of the user who created the record. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the record. |
| _modifiedby_value | modifiedby |
Unique identifier of the user who modified the record. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who modified the record. |
| _organizationid_value | organizationid |
Unique identifier for the organization |
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_searchrelationshipsettings_createdby |
| createdonbehalfby | systemuser | lk_searchrelationshipsettings_createdonbehalfby |
| modifiedby | systemuser | lk_searchrelationshipsettings_modifiedby |
| modifiedonbehalfby | systemuser | lk_searchrelationshipsettings_modifiedonbehalfby |
| organizationid | organization | organization_searchrelationshipsettings |
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 |
|---|---|---|
| searchrelationshipsettings_AsyncOperations | asyncoperation | regardingobjectid_searchrelationshipsettings |
| searchrelationshipsettings_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_searchrelationshipsettings |
| searchrelationshipsettings_DuplicateBaseRecord | duplicaterecord | baserecordid_searchrelationshipsettings |
| searchrelationshipsettings_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_searchrelationshipsettings |
| searchrelationshipsettings_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_searchrelationshipsettings |
| searchrelationshipsettings_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_searchrelationshipsettings |
| searchrelationshipsettings_ProcessSession | processsession | regardingobjectid_searchrelationshipsettings |
| searchrelationshipsettings_SyncErrors | syncerror | regardingobjectid_searchrelationshipsettings |
Operations
The following operations can be used with the searchrelationshipsettings entity type.
| Name | Binding |
|---|---|
| BulkRetain | Not Bound |
| CreateMultiple | Not Bound |
| DeleteMultiple | Not Bound |
| IsValidStateTransition | Not Bound |
| PurgeRetainedContent | Not Bound |
| Restore | Not Bound |
| Retain | Not Bound |
| RollbackRetain | Not Bound |
| UpdateMultiple | Not Bound |
| ValidateRetentionConfig | Not Bound |