sdkmessagefilter EntityType

Filter that defines which SDK messages are valid for each type of entity.

Entity Set Path
[organization URI]/api/data/v9.0/sdkmessagefilters
Base Type
crmbaseentity
Display Name
Sdk Message Filter
Primary Key
sdkmessagefilterid
Operations Supported
GET

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
availability Edm.Int32

Identifies where a method will be exposed. 0 - Server, 1 - Client, 2 - both.

Display Name: Availability

componentstate Edm.Int32

For internal use only.

Display Name: Component State

Read Only
Default Options
Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
createdon Edm.DateTimeOffset

Date and time when the SDK message filter was created.

Display Name: Created On

Read Only
customizationlevel Edm.Int32

Customization level of the SDK message filter.

Read Only
introducedversion Edm.String

Version in which the component is introduced.

Display Name: Introduced Version

iscustomprocessingstepallowed Edm.Boolean

Indicates whether a custom SDK message processing step is allowed.

Display Name: Custom Processing Step Allowed

Default Options
Value Label
1 Yes
0 No
ismanaged Edm.Boolean

Information that specifies whether this component is managed.

Display Name: State

Read Only
Default Options
Value Label
1 Managed
0 Unmanaged
isvisible Edm.Boolean

Indicates whether the filter should be visible.

Read Only
Default Options
Value Label
1 Yes
0 No
modifiedon Edm.DateTimeOffset

Date and time when the SDK message filter was last modified.

Display Name: Modified On

Read Only
overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
primaryobjecttypecode Edm.String

Type of entity with which the SDK message filter is primarily associated.

Display Name: Primary Object Type Code

Read Only
restrictionlevel Edm.Int32

For internal use only.

sdkmessagefilterid Edm.Guid

Unique identifier of the SDK message filter entity.

sdkmessagefilteridunique Edm.Guid

Unique identifier of the SDK message filter.

Read Only
secondaryobjecttypecode Edm.String

Type of entity with which the SDK message filter is secondarily associated.

Display Name: Secondary Object Type Code

Read Only
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
versionnumber Edm.Int64
Read Only
workflowsdkstepenabled Edm.Boolean

Whether or not the SDK message can be called from a workflow.

Display Name: WorkflowSdkStepEnabled

Read Only
Default Options
Value Label
1 Yes
0 No

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 Retrieve data about lookup properties.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the SDK message filter.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the sdkmessagefilter.

_modifiedby_value modifiedby

Unique identifier of the user who last modified the SDK message filter.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who last modified the sdkmessagefilter.

_organizationid_value organizationid

Unique identifier of the organization with which the SDK message filter is associated.

_sdkmessageid_value sdkmessageid

Unique identifier of the related SDK message.

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 createdby_sdkmessagefilter
createdonbehalfby systemuser lk_sdkmessagefilter_createdonbehalfby
modifiedby systemuser modifiedby_sdkmessagefilter
modifiedonbehalfby systemuser lk_sdkmessagefilter_modifiedonbehalfby
organizationid organization organization_sdkmessagefilter
sdkmessageid sdkmessage sdkmessageid_sdkmessagefilter

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
sdkmessagefilterid_sdkmessageprocessingstep sdkmessageprocessingstep sdkmessagefilterid

Solutions

The following solutions include the sdkmessagefilter entity type.

Name Description
System Solution Internal CRM System Solution

See also