synapselinkprofile EntityType

Synapse Link Profile

Entity Set Path
[organization URI]/api/data/v9.2/synapselinkprofiles
Base Type
crmbaseentity
Display Name
Synapse Link Profile
Primary Key
synapselinkprofileid
Primary Key Attribute
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
activationtime Edm.DateTimeOffset

Activation time of profile

Display Name: Activation Time

componentidunique Edm.Guid

For internal use only.

Display Name: Row id unique

Read Only
componentstate Edm.Int32

For internal use only.

Display Name: Component State

Read Only
Default Options
Values Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
copyattachments Edm.Boolean

Enable Copy Attachments

Display Name: Copy Attachments

Default Options
Values Label
1 Yes
0 No
copyfiles Edm.Boolean

Enable Copy Files

Display Name: Copy Files

Default Options
Values Label
1 Yes
0 No
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
destinationsyncstate Edm.Int32

Sync state of the profile

Display Name: Destination Sync State

Default Options
Values Label
0 None
1 NotCompleted
2 Completed
extendedproperties Edm.String

Extended properties

Display Name: Extended Properties

importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

iscustomizable BooleanManagedProperty

For internal use only.

Display Name: Is Customizable

ismanaged Edm.Boolean

Indicates whether the solution component is part of a managed solution.

Display Name: Is Managed

Read Only
Default Options
Values Label
1 Managed
0 Unmanaged
modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
name Edm.String

The name of the custom entity.

Display Name: Name

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
profilestate Edm.Int32

State of the profile

Display Name: Profile State

Default Options
Values Label
0 Inactive
1 Active
2 Error
3 Deleted
4 Aborting
5 Aborted
6 Suspended
7 Suspending
8 Deactivated
profiletype Edm.Int32

Type of profile

Display Name: Profile Type

Default Options
Values Label
0 SynapseLink
1 EventAnalytics
profileupdatedtime Edm.DateTimeOffset

Profile Updated Time

Display Name: Profile Updated Time

profileversion Edm.String

Profile version

Display Name: Profile Version

snapshotstopersist Edm.Int32

Number of snapshots To persist

Display Name: Snapshots To Persist

solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
statecode Edm.Int32

Status of the Synapse Link Profile

Display Name: Status

Default Options
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the Synapse Link Profile

Display Name: Status Reason

Default Options
Values Label
1 Active
2 Inactive
synapselinkprofileid Edm.Guid

Unique identifier for entity instances

Display Name: Synapse Link Profile

timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

uniquename Edm.String

Unique name

Display Name: Unique Name

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.

_datalakefolder_value datalakefolder

Unique identifier for Data Lake Folder associated with Synapse Link Profile.

_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_synapselinkprofile_createdby
createdonbehalfby systemuser lk_synapselinkprofile_createdonbehalfby
datalakefolder datalakefolder synapselinkprofiles
modifiedby systemuser lk_synapselinkprofile_modifiedby
modifiedonbehalfby systemuser lk_synapselinkprofile_modifiedonbehalfby
organizationid organization organization_synapselinkprofile

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
profileentities synapselinkprofileentity profile
profileentitystates synapselinkprofileentitystate profile
profileschedules synapselinkschedule profile
synapselinkprofile_AsyncOperations asyncoperation regardingobjectid_synapselinkprofile
synapselinkprofile_BulkDeleteFailures bulkdeletefailure regardingobjectid_synapselinkprofile
synapselinkprofile_DuplicateBaseRecord duplicaterecord baserecordid_synapselinkprofile
synapselinkprofile_DuplicateMatchingRecord duplicaterecord duplicaterecordid_synapselinkprofile
synapselinkprofile_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_synapselinkprofile
synapselinkprofile_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_synapselinkprofile
synapselinkprofile_ProcessSession processsession regardingobjectid_synapselinkprofile
synapselinkprofile_SyncErrors syncerror regardingobjectid_synapselinkprofile

Operations

The following operations can be used with the synapselinkprofile entity type.

Name Binding
CreateMultiple Not Bound
IsValidStateTransition Not Bound
UpdateMultiple Not Bound

See also