Menu

List of Open API

View the detailed information on Open API, including the descriptions of each method.

Method

URL

Description

selectDeviceLocation

/emm/oapi/device/selectDeviceLocation/

Queries the GPS information of the device.

selectDevicesByUser

/emm/oapi/device/selectDevicesByUser/

Queries the device information of the users.

selectDeviceInfo

/emm/oapi/device/selectDeviceInfo/

Queries the device detailed information.

selectDeviceList

/emm/oapi/device/selectDeviceList/

Queries the device information list.

insertDeviceToProfileGroup

/emm/oapi/device/insertDeviceToProfileGroup/

Assigns a device to a profile group.

insertMalwareApp

/emm/oapi/device/insertMalwareApp/

Inserts a malware application.

deleteDeviceFromProfile Group

/emm/oapi/device/deleteDeviceFromProfileGroup

Deletes the device from the profile group.

sendDeviceControlFor UpdateProfile (tenantId, deviceId)

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForUpdateProfile

Updates the profiles currently assigned to the device.

sendDeviceControlFor DeleteAppData (tenantId, deviceId,<Application list>)

/emm/oapi/mdm/commonOTCServiceWrapper/sendD eviceControlForDeleteAppData

Deletes the data of the relevant app from the device.

selectDeviceInfoByMobileId

/emm/oapi/device/selectDeviceInfoByMobileId/

Queries the device detailed information by mobile ID.

selectDeviceListByEmpNos

/emm/oapi/device/selectDeviceListByEmpNos/

Queries the device information list by employee number.

selectDeviceInfoByImei

/emm/oapi/device/selectDeviceInfoByImei

Queries the information about the device using its IMEI.

selectDeviceInfo BySerialNumber

/emm/oapi/device/selectDeviceInfoBySerialNumber

Queries the information about the device using its serial number.

selectDeviceAppList

/emm/oapi/device/selectDeviceAppList

Queries a list of apps on the device:

For an Android device, this queries a list of all apps installed on the device.

For an iOS device, this queries a list of all apps excluding the preloaded apps.

deleteDeviceFrom DeviceGroup

/emm/oapi/device/deleteDeviceFromDeviceGroup

Deletes a device from the devices group.

selectDeviceLocation History

/emm/oapi/device/selectDeviceLocationHistory

Queries the location history of the device.

checkDeviceConnection

/emm/oapi/device/checkDeviceConnection

Queries the connection status of the device through SA.

sendDeviceControl ForUserDefinedEvent

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForUser DefinedEvent/

Sends a device control to a device for user-defined events.

getDeviceControlResult

/emm/oapi/mdm/commonOTCServiceWrapper/getDeviceControlResult/

Returns messages of the device control process.

sendDeviceControl ForAgentFlushQueue

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForAgent FlushQueue/

Sends a device control to flush the command queue in the EMM server.

sendDeviceControlForAgent FlushQueueToMultiDevices

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForAgent FlushQueueToMultiDevices/

Sends a device control to several devices for flushing the command queues.

sendDeviceControl ForFactoryReset

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForFactoryReset/

Sends a device control to wipe a device.

sendDeviceControl ForGPSInfo

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForGPSInfo/

Sends a device control to get the location of a device.

sendDeviceControlFor RemoveAllKNOX

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForRemove AllKnox/

Sends a device control to remove the whole Knox Workspace on the device.

sendDeviceControl ForUnEnrollment

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForUnEnrollment/

Sends a device control to deactivate the device.

sendDeviceControl ForLockDevice

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForLockDevice/

Sends a device control to lock a device.

sendDeviceControl ForUnLockDevice

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForUnLock Device/

Sends a device control to unlock a device.

sendDeviceControl ForUserDefinedEvent

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForUser DefinedEvent/

Sends a device control to a device for triggering the user-defined event policies.

sendDeviceControlForUser DefinedEventToMultiDevices

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForUser DefinedEventToMultiDevices/

Sends a device control to several devices for the user-defined event policies.

sendDeviceControlForUser DefinedEventToMulti DevicesNR

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForUser DefinedEventToMultiDevicesNR/

Sends a device control to several devices for the user-defined event policies.

NOTE— This API does not return a command ID as a result of sending a device control.

sendDeviceControl ForGateEvent

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForGateEvent/

Sends a device control to a device for triggering the gate event policies.

sendDeviceControlForUser DefinedEventToMultiDevices

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForUserDefined EventToMultiDevices/

Sends a device control to multiple devices for user-defined events.

sendDeviceControlForGate EventToMultiDevices

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForGateEvent ToMultiDevices/

Sends a device control to multiple devices for gate events.

sendDeviceControlForUser DefinedEvent ToMultiDevicesNR

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForUserDefined EventToMultiDevicesNR/

Sends a device control to multiple devices for user-defined events (no response).

sendDeviceControlForGate EventToMultiDevicesNR

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForGateEvent ToMultiDevicesNR/

Sends a device control to multiple devices for gate events (no response).

sendDeviceControlForGate EventToMultiDevices

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForGate EventToMultiDevices/

Sends a device control to several devices for the gate event policies.

sendDeviceControlForGate EventToMultiDevicesNR

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForGate EventToMultiDevicesNR/

Sends a device control to several devices for the gate event policies.

Note :

  • This API does not return a command ID as a result of sending a device control.
  • For Android devices, this API is faster than “/sendDevice ControlForGate EventToMulti Devices

sendDeviceControl ForKeepalive

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForKeepalive/

Sends a device control to a device for requesting the Keepalive service.

sendDeviceControl ForDeviceInfo

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForDeviceInfo/

Sends a device control to a device for viewing the device information.

sendDeviceControlForAgent FlushQueue

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForAgentFlush Queue/

Sends a device control to a device to flush the agent command queue.

sendDeviceControlForAgent FlushQueueToMultiDevices

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForAgentFlush QueueToMultiDevices/

Sends a device control to multiple devices to flush the agent command queue.

getUserDefinedEvent InformationOfDevice

/emm/oapi/mdm/profileServiceWrapper/getUserDefinedEventInformation OfDevice/

Receives the events information of a device. The returned information includes the meta data of each event which is applied to the device.

insertDevice

/emm/oapi/user/createDevice/

Creates the devices.

insertUser

/emm/oapi/user/createUser/

Creates the users.

purgeUser

/emm/oapi/user/purgeUser/

Purges the users.

NOTE— The users to be purged should not have any activated mobile devices.

activateUser

/emm/oapi/user/activateUser/

Activates the users.

deactivateUser

/emm/oapi/user/deactivateUser/

Deactivates the users.

updateUser

/emm/oapi/user/updateUser/

Updates the users.

deleteDevice

/emm/oapi/user/deleteDevice/

Deletes the devices.

updatePassword

/emm/oapi/user/updatePassword/

Updates the user password

selectUserWithID

/emm/oapi/user/selectUserWithID

Selects the user with the ID.

selectUsers

/emm/oapi/user/selectUsers

Selects the users.

getCommandQueued DevicesForAndroidAgent

/emm/oapi/mdm/commandQueueServiceWrapper/getCommandQueuedDevices ForAndroidAgent/

Receives a list of phone numbers which have unresolved commands in the command queue.

getCommandQueue NoSendCnt

/emm/oapi/mdm/commandQueueServiceWrapper/getCommandQueueNoSendCnt/

Queries the command queue that has not been sending a device control to the devices.

getUserDefinedEvent InformationOfDevice

/emm/oapi/mdm/profileServiceWrapper/getUserDefinedEventInformation OfDevice/

Queries the user-defined events allocated to the devices.

getIOSPayloadUUIDList

/emm/oapi/mdm/profileServiceWrapper/getIOSPayloadUUIDList

Queries the payload UUID of iOS devices.

selectSMSQueueList

/emm/oapi/message/selectSMSQueueList/

Queries the SMS queue list.

updateSMSQueue

/emm/oapi/message/updateSMSQueue/

Updates the SMS queue information.

deleteSMSQueue

/emm/oapi/message/deleteSMSQueue/

Deletes the SMS queue information.

authenticate

/emm/oapi/auth/authenticate

Authenticates the user.

isLicenseValid

/emm/oapi/license/isLicenseValid

Queries the validity of the license.

write

/emm/oapi/audit/write/

Writes an audit log.

selectGroups

/emm/oapi/group/selectGroups

Queries the groups.

selectGroupUnits

/emm/oapi/group/selectGroupUnits

Queries the groups in detail.

selectGroupUsers

/emm/oapi/group/selectGroupUsers

Queries the list of group users.

countGroup

/emm/oapi/group/countGroup

Checks for duplicate group names.

insertGroup

/emm/oapi/group/insertGroup

Creates a user or a device group.

deleteGroup

/emm/oapi/group/deleteGroup

Deletes a group.

insertGroupEntity

/emm/oapi/group/insertGroupEntity

Adds a member (user or device) to a group.

deleteGroupUnits

/emm/oapi/group/deleteGroupUnits

Deletes a member (user or device) from a group.

selectGroupDevices

/emm/oapi/group/selectGroupDevices

Queries the list of groups devices.

create

/emm/oapi/org/create

Creates an organization.

delete

/emm/oapi/org/delete

Deletes the organization.

update

/emm/oapi/org/update

Updates the organization information.

addMembers

/emm/oapi/org/addMembers

Adds the users to a specific organization when changing the organization.

selectList

/emm/oapi/org/selectList

Queries a list of organizations.

select

/emm/oapi/org/select

Queries the organization in detail.

selectUsers

/emm/oapi/org/selectUsers

Queries a list of users in a specific organization.

selectDevices

/emm/oapi/org/selectDevices

Queries a list of devices in a specific organization.

sendDeviceControl ForUserInfo

emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForUserInfo

Sends the device command to devices to update user information.

sendDeviceControlFor UserInfoToMultiDevices

emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForUserInfo ToMultiDevices

Sends the device command to multi devices to update user information.

sendDeviceControlFor ResetPassword

emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForReset Password

This API sends a Device Control to reset screen or container pass word on a device.

sendDeviceControl ForRunApp

emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForRunApp

This API sends a Device Control to run an application on a device.

sendDeviceControlForReset Password

/emm/oapi/mdm/commonOTCServiceWrapper/sendDeviceControlForReset Password

Resets the screen lock or container lock password of an Android device.

COMMAND_POWEROFF_DEVICE /emm/oapi/mdm/commonOTCServiceWrapper/COMMAND_POWEROFF_DEVICE Sends the device command to turn off a device

getCommandQueued DevicesForAndroidAgent

/emm/oapi/mdm/commandQueueServiceWrapper/getCommandQueuedDevicesFor AndroidAgent/

Queries the list of the Android devices that have an unprocessed agent command queue.