sdkmessage EntityType

Message that is supported by the SDK.

Entity Set Path
[organization URI]/api/data/v9.0/sdkmessages
Base Type
crmbaseentity
Display Name
Sdk Message
Primary Key
sdkmessageid
Primary Key Attribute
name
Operations Supported
GET

Properties

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

Name Type Details
autotransact Edm.Boolean

Information about whether the SDK message is automatically transacted.

Display Name: Auto Transact

Default Options
Value Label
1 Yes
0 No
availability Edm.Int32

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

Display Name: Availability

categoryname Edm.String

If this is a categorized method, this is the name, otherwise None.

Display Name: Category Name

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 was created.

Display Name: Created On

Read Only
customizationlevel Edm.Int32

Customization level of the SDK message.

Read Only
executeprivilegename Edm.String

Name of the privilege that allows execution of the SDK message

Display Name: Execute Privilege Name

expand Edm.Boolean

Indicates whether the SDK message should have its requests expanded per primary entity defined in its filters.

Display Name: Expand

Default Options
Value Label
1 Yes
0 No
introducedversion Edm.String

Version in which the component is introduced.

Display Name: Introduced Version

isactive Edm.Boolean

Information about whether the SDK message is active.

Display Name: Is Active

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
isprivate Edm.Boolean

Indicates whether the SDK message is private.

Display Name: Is Private

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

Identifies whether an SDK message will be ReadOnly or Read Write. false - ReadWrite, true - ReadOnly .

Display Name: Intent

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

For internal use only.

Display Name: Is Valid for Execute Async

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

Date and time when the SDK message was last modified.

Display Name: Modified On

Read Only
name Edm.String

Name of the SDK message.

Display Name: Name

overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
sdkmessageid Edm.Guid

Unique identifier of the SDK message entity.

sdkmessageidunique Edm.Guid

Unique identifier of the SDK message.

Read Only
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
template Edm.Boolean

Indicates whether the SDK message is a template.

Display Name: Template

Default Options
Value Label
1 Yes
0 No
throttlesettings Edm.String

For internal use only.

Display Name: Throttle Settings

Read Only
versionnumber Edm.Int64

Number that identifies a specific revision of the SDK message.

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.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the sdkmessage.

_modifiedby_value modifiedby

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

_modifiedonbehalfby_value modifiedonbehalfby

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

_organizationid_value organizationid

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

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_sdkmessage
createdonbehalfby systemuser lk_sdkmessage_createdonbehalfby
modifiedby systemuser modifiedby_sdkmessage
modifiedonbehalfby systemuser lk_sdkmessage_modifiedonbehalfby
organizationid organization organization_sdkmessage

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
CustomAPIId customapi SdkMessageId
sdkmessage_serviceplanmapping serviceplanmapping SdkMessage
sdkmessageid_sdkmessagefilter sdkmessagefilter sdkmessageid
sdkmessageid_sdkmessageprocessingstep sdkmessageprocessingstep sdkmessageid

Solutions

The following solutions include the sdkmessage entity type.

Name Description
API messages extension solution This solution contains CDS API message extensions.

See also