msdyn_iotdevicecommand EntityType

Represents an outgoing message to a device connected to an IoT hub.

Entity Set Path
[organization URI]/api/data/v9.0/msdyn_iotdevicecommands
Base Type
crmbaseentity
Display Name
IoT Device Command
Primary Key
msdyn_iotdevicecommandid
Primary Key Attribute
msdyn_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
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
msdyn_commandstatus Edm.Int32

Describes the status of the command. If this stays at "In Progress" for a long time, verify the IoT endpoint configuration.

Display Name: Command Status

Default Options
Value Label
192350000 In Progress
192350001 Sent
192350002 Error
msdyn_commandstatusreason Edm.String

A reason field that explains the command status.

Display Name: Command Status Reason

msdyn_deviceid Edm.String

The ID of the IoT device to send the message to.

Display Name: Device ID

msdyn_iotdevicecommandid Edm.Guid

Unique identifier for entity instances

Display Name: IoT Device Command

msdyn_message Edm.String

Message to send to the IoT device. E.g.: A Json string.

Display Name: Message

msdyn_name Edm.String

The name of the custom entity.

Display Name: Name

msdyn_sendtoallconnecteddevices Edm.Boolean

Yes, if a copy of the command should be sent to all registered devices connected under the parent entity of the selected device. No, if this command needs to be sent only to the selected device.

Display Name: Send To All Connected Devices

Default Options
Value Label
1 Yes
0 No
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

statecode Edm.Int32

Status of the IoT Device Command

Display Name: Status

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

Reason for the status of the IoT Device Command

Display Name: Status Reason

Default Options
Value Label
1 Active
2 Inactive
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 Retrieve data about lookup properties.

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.

_msdyn_customerasset_value msdyn_CustomerAsset

The command will be sent to a device connected to this asset.

_msdyn_device_value msdyn_Device

IoT device to send the message to.

_msdyn_parentalert_value msdyn_ParentAlert

Reference to a parent alert in response to which the message is being sent.

_ownerid_value ownerid

Owner Id

_owningbusinessunit_value owningbusinessunit

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

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_msdyn_iotdevicecommand_createdby
createdonbehalfby systemuser lk_msdyn_iotdevicecommand_createdonbehalfby
modifiedby systemuser lk_msdyn_iotdevicecommand_modifiedby
modifiedonbehalfby systemuser lk_msdyn_iotdevicecommand_modifiedonbehalfby
msdyn_CustomerAsset msdyn_customerasset msdyn_msdyn_customerasset_msdyn_iotdevicecommand_CustomerAsset
msdyn_Device msdyn_iotdevice msdyn_msdyn_iotdevice_msdyn_iotdevicecommand_Device
msdyn_ParentAlert msdyn_iotalert msdyn_msdyn_iotalert_msdyn_iotdevicecommand_ParentAlert
ownerid principal owner_msdyn_iotdevicecommand
owningbusinessunit businessunit business_unit_msdyn_iotdevicecommand
owningteam team team_msdyn_iotdevicecommand
owninguser systemuser user_msdyn_iotdevicecommand

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
msdyn_iotdevicecommand_Annotations annotation objectid_msdyn_iotdevicecommand
msdyn_iotdevicecommand_AsyncOperations asyncoperation regardingobjectid_msdyn_iotdevicecommand
msdyn_iotdevicecommand_BulkDeleteFailures bulkdeletefailure regardingobjectid_msdyn_iotdevicecommand
msdyn_iotdevicecommand_connections1 connection record1id_msdyn_iotdevicecommand
msdyn_iotdevicecommand_connections2 connection record2id_msdyn_iotdevicecommand
msdyn_iotdevicecommand_DuplicateBaseRecord duplicaterecord baserecordid_msdyn_iotdevicecommand
msdyn_iotdevicecommand_DuplicateMatchingRecord duplicaterecord duplicaterecordid_msdyn_iotdevicecommand
msdyn_iotdevicecommand_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_msdyn_iotdevicecommand
msdyn_iotdevicecommand_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_msdyn_iotdevicecommand
msdyn_iotdevicecommand_ProcessSession processsession regardingobjectid_msdyn_iotdevicecommand
msdyn_iotdevicecommand_SyncErrors syncerror regardingobjectid_msdyn_iotdevicecommand
msdyn_msdyn_iotdevicecommand_msdyn_customerasset_LastCommandSent msdyn_customerasset msdyn_LastCommandSent
msdyn_msdyn_iotdevicecommand_msdyn_iotalert_LastCommandSent msdyn_iotalert msdyn_LastCommandSent
msdyn_msdyn_iotdevicecommand_msdyn_iotdevice_LastCommandSent msdyn_iotdevice msdyn_LastCommandSent

Operations

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

Name Binding
GrantAccess Not Bound
IsValidStateTransition Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

Solutions

The following solutions include the msdyn_iotdevicecommand entity type.

Name Description
Connected Field Service for Microsoft Dynamics 365 Use Connected Field Service to monitor connected devices to make sure your customer’s equipment is always functioning properly. If a piece of equipment fails, you’ll receive a notification, so that you can troubleshoot the problem remotely or send a technician to fix it.
IoT Connector for Microsoft Dynamics 365 Enables IoT scenarios in Dynamics 365.

See also