sdkmessage EntityType
Message that is supported by the SDK.
- Entity set path:
- [organization URI]/api/data/v9.2/sdkmessages
- Base type:
- crmbaseentity
- Display name:
- Sdk Message
- Primary key:
- sdkmessageid
- Primary name column:
- 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
|
||||||||||
| 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
|
||||||||||
| 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
|
||||||||||
| 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
|
||||||||||
| ismanaged | Edm.Boolean |
Information that specifies whether this component is managed. Display name: State Read only
Default options
|
||||||||||
| isprivate | Edm.Boolean |
Indicates whether the SDK message is private. Display name: Is Private
Default options
|
||||||||||
| isreadonly | Edm.Boolean |
Identifies whether an SDK message will be ReadOnly or Read Write. false - ReadWrite, true - ReadOnly . Display name: Intent
Default options
|
||||||||||
| isvalidforexecuteasync | Edm.Boolean |
For internal use only. Display name: Is Valid for Execute Async Read only
Default options
|
||||||||||
| 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
|
||||||||||
| 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
|
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 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 |