Skip to content

Latest commit

 

History

History
442 lines (318 loc) · 11.9 KB

DevicesApi.md

File metadata and controls

442 lines (318 loc) · 11.9 KB

DevicesApi

All URIs are relative to https://api.artik.cloud/v1.1

Method HTTP request Description
addDevice POST /devices Add Device
deleteDevice DELETE /devices/{deviceId} Delete Device
deleteDeviceToken DELETE /devices/{deviceId}/tokens Delete Device Token
getDevice GET /devices/{deviceId} Get Device
getDevicePresence GET /devices/{deviceId}/presence Get device presence information
getDeviceToken GET /devices/{deviceId}/tokens Get Device Token
updateDevice PUT /devices/{deviceId} Update Device
updateDeviceToken PUT /devices/{deviceId}/tokens Update Device Token

addDevice

DeviceEnvelope addDevice(device)

Add Device

Create a device

Example

// Import classes:
//import cloud.artik.client.ApiClient;
//import cloud.artik.client.ApiException;
//import cloud.artik.client.Configuration;
//import cloud.artik.client.auth.*;
//import cloud.artik.api.DevicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: artikcloud_oauth
OAuth artikcloud_oauth = (OAuth) defaultClient.getAuthentication("artikcloud_oauth");
artikcloud_oauth.setAccessToken("YOUR ACCESS TOKEN");

DevicesApi apiInstance = new DevicesApi();
Device device = new Device(); // Device | Device to be added to the user
try {
    DeviceEnvelope result = apiInstance.addDevice(device);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DevicesApi#addDevice");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
device Device Device to be added to the user

Return type

DeviceEnvelope

Authorization

artikcloud_oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteDevice

DeviceEnvelope deleteDevice(deviceId)

Delete Device

Deletes a device

Example

// Import classes:
//import cloud.artik.client.ApiClient;
//import cloud.artik.client.ApiException;
//import cloud.artik.client.Configuration;
//import cloud.artik.client.auth.*;
//import cloud.artik.api.DevicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: artikcloud_oauth
OAuth artikcloud_oauth = (OAuth) defaultClient.getAuthentication("artikcloud_oauth");
artikcloud_oauth.setAccessToken("YOUR ACCESS TOKEN");

DevicesApi apiInstance = new DevicesApi();
String deviceId = "deviceId_example"; // String | deviceId
try {
    DeviceEnvelope result = apiInstance.deleteDevice(deviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DevicesApi#deleteDevice");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
deviceId String deviceId

Return type

DeviceEnvelope

Authorization

artikcloud_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

deleteDeviceToken

DeviceTokenEnvelope deleteDeviceToken(deviceId)

Delete Device Token

Deletes a device's token

Example

// Import classes:
//import cloud.artik.client.ApiClient;
//import cloud.artik.client.ApiException;
//import cloud.artik.client.Configuration;
//import cloud.artik.client.auth.*;
//import cloud.artik.api.DevicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: artikcloud_oauth
OAuth artikcloud_oauth = (OAuth) defaultClient.getAuthentication("artikcloud_oauth");
artikcloud_oauth.setAccessToken("YOUR ACCESS TOKEN");

DevicesApi apiInstance = new DevicesApi();
String deviceId = "deviceId_example"; // String | deviceId
try {
    DeviceTokenEnvelope result = apiInstance.deleteDeviceToken(deviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DevicesApi#deleteDeviceToken");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
deviceId String deviceId

Return type

DeviceTokenEnvelope

Authorization

artikcloud_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getDevice

DeviceEnvelope getDevice(deviceId)

Get Device

Retrieves a device

Example

// Import classes:
//import cloud.artik.client.ApiClient;
//import cloud.artik.client.ApiException;
//import cloud.artik.client.Configuration;
//import cloud.artik.client.auth.*;
//import cloud.artik.api.DevicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: artikcloud_oauth
OAuth artikcloud_oauth = (OAuth) defaultClient.getAuthentication("artikcloud_oauth");
artikcloud_oauth.setAccessToken("YOUR ACCESS TOKEN");

DevicesApi apiInstance = new DevicesApi();
String deviceId = "deviceId_example"; // String | deviceId
try {
    DeviceEnvelope result = apiInstance.getDevice(deviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DevicesApi#getDevice");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
deviceId String deviceId

Return type

DeviceEnvelope

Authorization

artikcloud_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getDevicePresence

PresenceEnvelope getDevicePresence(deviceId)

Get device presence information

Return the presence status of the given device along with the time it was last seen

Example

// Import classes:
//import cloud.artik.client.ApiClient;
//import cloud.artik.client.ApiException;
//import cloud.artik.client.Configuration;
//import cloud.artik.client.auth.*;
//import cloud.artik.api.DevicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: artikcloud_oauth
OAuth artikcloud_oauth = (OAuth) defaultClient.getAuthentication("artikcloud_oauth");
artikcloud_oauth.setAccessToken("YOUR ACCESS TOKEN");

DevicesApi apiInstance = new DevicesApi();
String deviceId = "deviceId_example"; // String | Device ID.
try {
    PresenceEnvelope result = apiInstance.getDevicePresence(deviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DevicesApi#getDevicePresence");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
deviceId String Device ID.

Return type

PresenceEnvelope

Authorization

artikcloud_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getDeviceToken

DeviceTokenEnvelope getDeviceToken(deviceId)

Get Device Token

Retrieves a device's token

Example

// Import classes:
//import cloud.artik.client.ApiClient;
//import cloud.artik.client.ApiException;
//import cloud.artik.client.Configuration;
//import cloud.artik.client.auth.*;
//import cloud.artik.api.DevicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: artikcloud_oauth
OAuth artikcloud_oauth = (OAuth) defaultClient.getAuthentication("artikcloud_oauth");
artikcloud_oauth.setAccessToken("YOUR ACCESS TOKEN");

DevicesApi apiInstance = new DevicesApi();
String deviceId = "deviceId_example"; // String | deviceId
try {
    DeviceTokenEnvelope result = apiInstance.getDeviceToken(deviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DevicesApi#getDeviceToken");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
deviceId String deviceId

Return type

DeviceTokenEnvelope

Authorization

artikcloud_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

updateDevice

DeviceEnvelope updateDevice(deviceId, device)

Update Device

Updates a device

Example

// Import classes:
//import cloud.artik.client.ApiClient;
//import cloud.artik.client.ApiException;
//import cloud.artik.client.Configuration;
//import cloud.artik.client.auth.*;
//import cloud.artik.api.DevicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: artikcloud_oauth
OAuth artikcloud_oauth = (OAuth) defaultClient.getAuthentication("artikcloud_oauth");
artikcloud_oauth.setAccessToken("YOUR ACCESS TOKEN");

DevicesApi apiInstance = new DevicesApi();
String deviceId = "deviceId_example"; // String | deviceId
Device device = new Device(); // Device | Device to be updated
try {
    DeviceEnvelope result = apiInstance.updateDevice(deviceId, device);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DevicesApi#updateDevice");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
deviceId String deviceId
device Device Device to be updated

Return type

DeviceEnvelope

Authorization

artikcloud_oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateDeviceToken

DeviceTokenEnvelope updateDeviceToken(deviceId)

Update Device Token

Updates a device's token

Example

// Import classes:
//import cloud.artik.client.ApiClient;
//import cloud.artik.client.ApiException;
//import cloud.artik.client.Configuration;
//import cloud.artik.client.auth.*;
//import cloud.artik.api.DevicesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: artikcloud_oauth
OAuth artikcloud_oauth = (OAuth) defaultClient.getAuthentication("artikcloud_oauth");
artikcloud_oauth.setAccessToken("YOUR ACCESS TOKEN");

DevicesApi apiInstance = new DevicesApi();
String deviceId = "deviceId_example"; // String | deviceId
try {
    DeviceTokenEnvelope result = apiInstance.updateDeviceToken(deviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DevicesApi#updateDeviceToken");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
deviceId String deviceId

Return type

DeviceTokenEnvelope

Authorization

artikcloud_oauth

HTTP request headers

  • Content-Type: text/plain
  • Accept: application/json