-
-
-
-
- devicesV2PassDelete
-delete devices_v2_pass
-Removes the password for the device.
- --
/v2/devices/{id}/pass-
Usage and SDK Samples
- --
-
- Curl - - - - - -
- JavaScript - - - - - - -
-
+
-
- curl -X DELETE \
- \
- -H "Accept: application/vnd.goa.error+json,text/plain" \
- "https://api2.arduino.cc/iot/v2/devices/{id}/pass"
-
-
- import org.openapitools.client.*;
-import org.openapitools.client.auth.*;
-import org.openapitools.client.model.*;
-import org.openapitools.client.api.DevicesV2PassApi;
+
+
+
-import java.io.File;
-import java.util.*;
-public class DevicesV2PassApiExample {
- public static void main(String[] args) {
- ApiClient defaultClient = Configuration.getDefaultApiClient();
+
+ -
+ Schema
+
- // Configure OAuth2 access token for authorization: oauth2
- OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
- oauth2.setAccessToken("YOUR ACCESS TOKEN");
- // Create an instance of the API class
- DevicesV2PassApi apiInstance = new DevicesV2PassApi();
- String id = id_example; // String | The id of the device
- try {
- apiInstance.devicesV2PassDelete(id);
- } catch (ApiException e) {
- System.err.println("Exception when calling DevicesV2PassApi#devicesV2PassDelete");
- e.printStackTrace();
- }
- }
-}
-
-
- import 'package:openapi/api.dart';
+
-final api_instance = DefaultApi();
-final String id = new String(); // String | The id of the device
+
+
+
+
+
+
+
+
+
+
+
-
-
-
- import org.openapitools.client.api.DevicesV2PassApi;
+
+ -
+ Schema
+
-public class DevicesV2PassApiExample {
- public static void main(String[] args) {
- DevicesV2PassApi apiInstance = new DevicesV2PassApi();
- String id = id_example; // String | The id of the device
- try {
- apiInstance.devicesV2PassDelete(id);
- } catch (ApiException e) {
- System.err.println("Exception when calling DevicesV2PassApi#devicesV2PassDelete");
- e.printStackTrace();
- }
- }
-}
-
+ Configuration *apiConfig = [Configuration sharedConfig];
-// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
-[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
+
-// Create an instance of the API class
-DevicesV2PassApi *apiInstance = [[DevicesV2PassApi alloc] init];
-String *id = id_example; // The id of the device (default to null)
-// delete devices_v2_pass
-[apiInstance devicesV2PassDeleteWith:id
- completionHandler: ^(NSError* error) {
- if (error) {
- NSLog(@"Error: %@", error);
- }
-}];
-
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
- + Schema + + + + + +
+
+
+
+
+
+
+
+
+ + +
DevicesV2Pass
+
+
+
+
+
+
+
+
+ devicesV2PassCheck
+check devices_v2_pass
+Check if the password matches.
+ ++
/v2/devices/{id}/pass+
Usage and SDK Samples
+ +-
+
- Curl + + + + + +
- JavaScript + + + + + + +
+
+
+ curl -X POST \
+ \
+ -H "Accept: application/vnd.goa.error+json,text/plain" \
+ -H "Content-Type: application/json,application/x-www-form-urlencoded" \
+ "https://api2.arduino.cc/iot/v2/devices/{id}/pass" \
+ -d '{
+ "password" : "password"
+}' \
+ -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded'
+
+
+
+ import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DevicesV2PassApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DevicesV2PassApiExample {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+
+ // Configure OAuth2 access token for authorization: oauth2
+ OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
+ oauth2.setAccessToken("YOUR ACCESS TOKEN");
+
+ // Create an instance of the API class
+ DevicesV2PassApi apiInstance = new DevicesV2PassApi();
+ String id = id_example; // String | The id of the device
+ CheckDevicesV2PassPayload checkDevicesV2PassPayload = ; // CheckDevicesV2PassPayload |
+
+ try {
+ apiInstance.devicesV2PassCheck(id, checkDevicesV2PassPayload);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling DevicesV2PassApi#devicesV2PassCheck");
+ e.printStackTrace();
+ }
+ }
+}
+
+
+
+ import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String id = new String(); // String | The id of the device
+final CheckDevicesV2PassPayload checkDevicesV2PassPayload = new CheckDevicesV2PassPayload(); // CheckDevicesV2PassPayload |
+
+try {
+ final result = await api_instance.devicesV2PassCheck(id, checkDevicesV2PassPayload);
+ print(result);
+} catch (e) {
+ print('Exception when calling DefaultApi->devicesV2PassCheck: $e\n');
+}
+
+
+
+
+ import org.openapitools.client.api.DevicesV2PassApi;
+
+public class DevicesV2PassApiExample {
+ public static void main(String[] args) {
+ DevicesV2PassApi apiInstance = new DevicesV2PassApi();
+ String id = id_example; // String | The id of the device
+ CheckDevicesV2PassPayload checkDevicesV2PassPayload = ; // CheckDevicesV2PassPayload |
+
+ try {
+ apiInstance.devicesV2PassCheck(id, checkDevicesV2PassPayload);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling DevicesV2PassApi#devicesV2PassCheck");
+ e.printStackTrace();
+ }
+ }
+}
+
+
+ Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
+[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
+
+
+// Create an instance of the API class
+DevicesV2PassApi *apiInstance = [[DevicesV2PassApi alloc] init];
+String *id = id_example; // The id of the device (default to null)
+CheckDevicesV2PassPayload *checkDevicesV2PassPayload = ; //
+
+// check devices_v2_pass
+[apiInstance devicesV2PassCheckWith:id
+ checkDevicesV2PassPayload:checkDevicesV2PassPayload
+ completionHandler: ^(NSError* error) {
+ if (error) {
+ NSLog(@"Error: %@", error);
+ }
+}];
+
+
-
- var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
@@ -22210,7 +22882,8 @@ Usage and SDK Samples
// Create an instance of the API class
var api = new ArduinoIotClient.DevicesV2PassApi()
var id = id_example; // {String} The id of the device
-api.devicesV2PassDelete(id).then(function() {
+var checkDevicesV2PassPayload = ; // {CheckDevicesV2PassPayload}
+api.devicesV2PassCheck(id, checkDevicesV2PassPayload).then(function() {
console.log('API called successfully.');
}, function(error) {
console.error(error);
@@ -22219,10 +22892,10 @@ Usage and SDK Samples
+
-
using System;
using System.Diagnostics;
using iot.Api;
@@ -22231,7 +22904,7 @@ Usage and SDK Samples
namespace Example
{
- public class devicesV2PassDeleteExample
+ public class devicesV2PassCheckExample
{
public void main()
{
@@ -22241,12 +22914,13 @@ Usage and SDK Samples
// Create an instance of the API class
var apiInstance = new DevicesV2PassApi();
var id = id_example; // String | The id of the device (default to null)
+ var checkDevicesV2PassPayload = new CheckDevicesV2PassPayload(); // CheckDevicesV2PassPayload |
try {
- // delete devices_v2_pass
- apiInstance.devicesV2PassDelete(id);
+ // check devices_v2_pass
+ apiInstance.devicesV2PassCheck(id, checkDevicesV2PassPayload);
} catch (Exception e) {
- Debug.Print("Exception when calling DevicesV2PassApi.devicesV2PassDelete: " + e.Message );
+ Debug.Print("Exception when calling DevicesV2PassApi.devicesV2PassCheck: " + e.Message );
}
}
}
@@ -22254,7 +22928,7 @@ Usage and SDK Samples
+
-
<?php
require_once(__DIR__ . '/vendor/autoload.php');
@@ -22264,16 +22938,17 @@ Usage and SDK Samples
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicesV2PassApi();
$id = id_example; // String | The id of the device
+$checkDevicesV2PassPayload = ; // CheckDevicesV2PassPayload |
try {
- $api_instance->devicesV2PassDelete($id);
+ $api_instance->devicesV2PassCheck($id, $checkDevicesV2PassPayload);
} catch (Exception $e) {
- echo 'Exception when calling DevicesV2PassApi->devicesV2PassDelete: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling DevicesV2PassApi->devicesV2PassCheck: ', $e->getMessage(), PHP_EOL;
}
?>
+
-
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DevicesV2PassApi;
@@ -22284,16 +22959,17 @@ Usage and SDK Samples
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicesV2PassApi->new();
my $id = id_example; # String | The id of the device
+my $checkDevicesV2PassPayload = WWW::OPenAPIClient::Object::CheckDevicesV2PassPayload->new(); # CheckDevicesV2PassPayload |
eval {
- $api_instance->devicesV2PassDelete(id => $id);
+ $api_instance->devicesV2PassCheck(id => $id, checkDevicesV2PassPayload => $checkDevicesV2PassPayload);
};
if ($@) {
- warn "Exception when calling DevicesV2PassApi->devicesV2PassDelete: $@\n";
+ warn "Exception when calling DevicesV2PassApi->devicesV2PassCheck: $@\n";
}
+
-
from __future__ import print_statement
import time
import openapi_client
@@ -22306,22 +22982,24 @@ Usage and SDK Samples
# Create an instance of the API class
api_instance = openapi_client.DevicesV2PassApi()
id = id_example # String | The id of the device (default to null)
+checkDevicesV2PassPayload = # CheckDevicesV2PassPayload |
try:
- # delete devices_v2_pass
- api_instance.devices_v2_pass_delete(id)
+ # check devices_v2_pass
+ api_instance.devices_v2_pass_check(id, checkDevicesV2PassPayload)
except ApiException as e:
- print("Exception when calling DevicesV2PassApi->devicesV2PassDelete: %s\n" % e)
+
extern crate DevicesV2PassApi;
pub fn main() {
let id = id_example; // String
+ let checkDevicesV2PassPayload = ; // CheckDevicesV2PassPayload
let mut context = DevicesV2PassApi::Context::default();
- let result = client.devicesV2PassDelete(id, &context).wait();
+ let result = client.devicesV2PassCheck(id, checkDevicesV2PassPayload, &context).wait();
println!("{:?}", result);
}
@@ -22346,7 +23024,7 @@ Parameters
-
+
@@ -22368,93 +23046,185 @@ Parameters
+ Body parameters
+
+
+ Name
+ Description
+
+ checkDevicesV2PassPayload *
+
+
+
+
+
+
Responses
-
-
+
+
-
+
-
+
-
-
+
+
-
+
-
+
-
-
+
+
-
+
+ -
+ Schema
+
+
+
-
+
+
+
+
+
+
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
- devicesV2PassGet
- get devices_v2_pass
+ devicesV2PassDelete
+ delete devices_v2_pass
- Returns whether the password for this device is set or not. It doesn't return the password.
+ Removes the password for the device.
- /v2/devices/{id}/pass
+ /v2/devices/{id}/pass
Usage and SDK Samples
- - Curl
-
-
-
-
-
- - JavaScript
-
-
-
-
-
-
+ - Curl
+
+
+
+
+
+ - JavaScript
+
+
+
+
+
+
-
- curl -X GET \
+
+ curl -X DELETE \
\
- -H "Accept: application/vnd.arduino.devicev2.pass+json,application/vnd.goa.error+json" \
- "https://api2.arduino.cc/iot/v2/devices/{id}/pass?suggested_password=true"
+ -H "Accept: application/vnd.goa.error+json,text/plain" \
+ "https://api2.arduino.cc/iot/v2/devices/{id}/pass"
-
+
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
@@ -22563,13 +23333,11 @@ Usage and SDK Samples
// Create an instance of the API class
DevicesV2PassApi apiInstance = new DevicesV2PassApi();
String id = id_example; // String | The id of the device
- Boolean suggestedPassword = true; // Boolean | If true, return a suggested password
try {
- ArduinoDevicev2Pass result = apiInstance.devicesV2PassGet(id, suggestedPassword);
- System.out.println(result);
+ apiInstance.devicesV2PassDelete(id);
} catch (ApiException e) {
- System.err.println("Exception when calling DevicesV2PassApi#devicesV2PassGet");
+ System.err.println("Exception when calling DevicesV2PassApi#devicesV2PassDelete");
e.printStackTrace();
}
}
@@ -22577,48 +23345,45 @@ Usage and SDK Samples
-
+
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String id = new String(); // String | The id of the device
-final Boolean suggestedPassword = new Boolean(); // Boolean | If true, return a suggested password
try {
- final result = await api_instance.devicesV2PassGet(id, suggestedPassword);
+ final result = await api_instance.devicesV2PassDelete(id);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->devicesV2PassGet: $e\n');
+ print('Exception when calling DefaultApi->devicesV2PassDelete: $e\n');
}
-
+
import org.openapitools.client.api.DevicesV2PassApi;
public class DevicesV2PassApiExample {
public static void main(String[] args) {
DevicesV2PassApi apiInstance = new DevicesV2PassApi();
String id = id_example; // String | The id of the device
- Boolean suggestedPassword = true; // Boolean | If true, return a suggested password
try {
- ArduinoDevicev2Pass result = apiInstance.devicesV2PassGet(id, suggestedPassword);
- System.out.println(result);
+ apiInstance.devicesV2PassDelete(id);
} catch (ApiException e) {
- System.err.println("Exception when calling DevicesV2PassApi#devicesV2PassGet");
+ System.err.println("Exception when calling DevicesV2PassApi#devicesV2PassDelete");
e.printStackTrace();
}
}
}
-
+
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
@@ -22628,15 +23393,10 @@ Usage and SDK Samples
// Create an instance of the API class
DevicesV2PassApi *apiInstance = [[DevicesV2PassApi alloc] init];
String *id = id_example; // The id of the device (default to null)
-Boolean *suggestedPassword = true; // If true, return a suggested password (optional) (default to false)
-// get devices_v2_pass
-[apiInstance devicesV2PassGetWith:id
- suggestedPassword:suggestedPassword
- completionHandler: ^(ArduinoDevicev2Pass output, NSError* error) {
- if (output) {
- NSLog(@"%@", output);
- }
+// delete devices_v2_pass
+[apiInstance devicesV2PassDeleteWith:id
+ completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
@@ -22644,7 +23404,7 @@ Usage and SDK Samples
-
+
var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;
@@ -22655,8 +23415,453 @@ Usage and SDK Samples
// Create an instance of the API class
var api = new ArduinoIotClient.DevicesV2PassApi()
var id = id_example; // {String} The id of the device
-var opts = {
- 'suggestedPassword': true // {Boolean} If true, return a suggested password
+api.devicesV2PassDelete(id).then(function() {
+ console.log('API called successfully.');
+}, function(error) {
+ console.error(error);
+});
+
+
+
+
+
+
+ using System;
+using System.Diagnostics;
+using iot.Api;
+using iot.Client;
+using iot.Model;
+
+namespace Example
+{
+ public class devicesV2PassDeleteExample
+ {
+ public void main()
+ {
+ // Configure OAuth2 access token for authorization: oauth2
+ Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
+
+ // Create an instance of the API class
+ var apiInstance = new DevicesV2PassApi();
+ var id = id_example; // String | The id of the device (default to null)
+
+ try {
+ // delete devices_v2_pass
+ apiInstance.devicesV2PassDelete(id);
+ } catch (Exception e) {
+ Debug.Print("Exception when calling DevicesV2PassApi.devicesV2PassDelete: " + e.Message );
+ }
+ }
+ }
+}
+
+
+
+
+ <?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure OAuth2 access token for authorization: oauth2
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DevicesV2PassApi();
+$id = id_example; // String | The id of the device
+
+try {
+ $api_instance->devicesV2PassDelete($id);
+} catch (Exception $e) {
+ echo 'Exception when calling DevicesV2PassApi->devicesV2PassDelete: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+
+
+ use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DevicesV2PassApi;
+
+# Configure OAuth2 access token for authorization: oauth2
+$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DevicesV2PassApi->new();
+my $id = id_example; # String | The id of the device
+
+eval {
+ $api_instance->devicesV2PassDelete(id => $id);
+};
+if ($@) {
+ warn "Exception when calling DevicesV2PassApi->devicesV2PassDelete: $@\n";
+}
+
+
+
+ from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: oauth2
+openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# Create an instance of the API class
+api_instance = openapi_client.DevicesV2PassApi()
+id = id_example # String | The id of the device (default to null)
+
+try:
+ # delete devices_v2_pass
+ api_instance.devices_v2_pass_delete(id)
+except ApiException as e:
+ print("Exception when calling DevicesV2PassApi->devicesV2PassDelete: %s\n" % e)
+
+
+
+ extern crate DevicesV2PassApi;
+
+pub fn main() {
+ let id = id_example; // String
+
+ let mut context = DevicesV2PassApi::Context::default();
+ let result = client.devicesV2PassDelete(id, &context).wait();
+
+ println!("{:?}", result);
+}
+
+
+
+
+ Scopes
+
+
+
+
+ Parameters
+
+ Path parameters
+
+
+ Name
+ Description
+
+ id*
+
+
+
+
+
+
+
+ String
+
+
+
+The id of the device
+
+
+
+ Required
+
+
+
+
+
+
+
+
+
+
+ Responses
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ devicesV2PassGet
+ get devices_v2_pass
+
+
+
+
+ Returns whether the password for this device is set or not. It doesn't return the password.
+
+
+ /v2/devices/{id}/pass
+
+
Usage and SDK Samples
+
+
+ - Curl
+
+
+
+
+
+ - JavaScript
+
+
+
+
+
+
+
+
+
+
+ curl -X GET \
+ \
+ -H "Accept: application/vnd.arduino.devicev2.pass+json,application/vnd.goa.error+json" \
+ "https://api2.arduino.cc/iot/v2/devices/{id}/pass?suggested_password=true"
+
+
+
+ import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DevicesV2PassApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DevicesV2PassApiExample {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+
+ // Configure OAuth2 access token for authorization: oauth2
+ OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
+ oauth2.setAccessToken("YOUR ACCESS TOKEN");
+
+ // Create an instance of the API class
+ DevicesV2PassApi apiInstance = new DevicesV2PassApi();
+ String id = id_example; // String | The id of the device
+ Boolean suggestedPassword = true; // Boolean | If true, return a suggested password
+
+ try {
+ ArduinoDevicev2Pass result = apiInstance.devicesV2PassGet(id, suggestedPassword);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling DevicesV2PassApi#devicesV2PassGet");
+ e.printStackTrace();
+ }
+ }
+}
+
+
+
+
+ import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String id = new String(); // String | The id of the device
+final Boolean suggestedPassword = new Boolean(); // Boolean | If true, return a suggested password
+
+try {
+ final result = await api_instance.devicesV2PassGet(id, suggestedPassword);
+ print(result);
+} catch (e) {
+ print('Exception when calling DefaultApi->devicesV2PassGet: $e\n');
+}
+
+
+
+
+
+ import org.openapitools.client.api.DevicesV2PassApi;
+
+public class DevicesV2PassApiExample {
+ public static void main(String[] args) {
+ DevicesV2PassApi apiInstance = new DevicesV2PassApi();
+ String id = id_example; // String | The id of the device
+ Boolean suggestedPassword = true; // Boolean | If true, return a suggested password
+
+ try {
+ ArduinoDevicev2Pass result = apiInstance.devicesV2PassGet(id, suggestedPassword);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling DevicesV2PassApi#devicesV2PassGet");
+ e.printStackTrace();
+ }
+ }
+}
+
+
+
+ Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
+[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
+
+
+// Create an instance of the API class
+DevicesV2PassApi *apiInstance = [[DevicesV2PassApi alloc] init];
+String *id = id_example; // The id of the device (default to null)
+Boolean *suggestedPassword = true; // If true, return a suggested password (optional) (default to false)
+
+// get devices_v2_pass
+[apiInstance devicesV2PassGetWith:id
+ suggestedPassword:suggestedPassword
+ completionHandler: ^(ArduinoDevicev2Pass output, NSError* error) {
+ if (output) {
+ NSLog(@"%@", output);
+ }
+ if (error) {
+ NSLog(@"Error: %@", error);
+ }
+}];
+
+
+
+
+ var ArduinoIotClient = require('@arduino/arduino-iot-client');
+var defaultClient = ArduinoIotClient.ApiClient.instance;
+
+// Configure OAuth2 access token for authorization: oauth2
+var oauth2 = defaultClient.authentications['oauth2'];
+oauth2.accessToken = "YOUR ACCESS TOKEN";
+
+// Create an instance of the API class
+var api = new ArduinoIotClient.DevicesV2PassApi()
+var id = id_example; // {String} The id of the device
+var opts = {
+ 'suggestedPassword': true // {Boolean} If true, return a suggested password
};
api.devicesV2PassGet(id, opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
@@ -26138,78 +27343,69 @@
-
- PropertiesV2
-
-
+
+ NetworkCredentialsV1
+
+
- propertiesV2Create
- create properties_v2
+ networkCredentialsV1Show
+ show network_credentials_v1
- Creates a new property associated to a thing
+ Show required network credentials depending on device type
- /v2/things/{id}/properties
+ /v1/network_credentials/{type}
Usage and SDK Samples
- - Curl
-
-
-
-
-
- - JavaScript
-
-
-
-
-
-
+ - Curl
+
+
+
+
+
+ - JavaScript
+
+
+
+
+
+
-
- curl -X PUT \
- \
- -H "Accept: application/vnd.arduino.property+json,application/vnd.goa.error+json" \
- -H "Content-Type: application/json,application/x-www-form-urlencoded" \
- "https://api2.arduino.cc/iot/v2/things/{id}/properties" \
- -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded'
+
+ curl -X GET \
+ -H "Accept: application/vnd.arduino.credentialsv1+json; type=collection" \
+ "https://api2.arduino.cc/iot/v1/network_credentials/{type}?connection=connection_example"
-
+
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
-import org.openapitools.client.api.PropertiesV2Api;
+import org.openapitools.client.api.NetworkCredentialsV1Api;
import java.io.File;
import java.util.*;
-public class PropertiesV2ApiExample {
+public class NetworkCredentialsV1ApiExample {
public static void main(String[] args) {
- ApiClient defaultClient = Configuration.getDefaultApiClient();
-
- // Configure OAuth2 access token for authorization: oauth2
- OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
- oauth2.setAccessToken("YOUR ACCESS TOKEN");
// Create an instance of the API class
- PropertiesV2Api apiInstance = new PropertiesV2Api();
- String id = id_example; // String | The id of the thing
- Property property = ; // Property |
- String xOrganization = xOrganization_example; // String | The id of the organization
+ NetworkCredentialsV1Api apiInstance = new NetworkCredentialsV1Api();
+ String type = type_example; // String | Device type
+ String connection = connection_example; // String | Connection used by the device
try {
- ArduinoProperty result = apiInstance.propertiesV2Create(id, property, xOrganization);
+ array[ArduinoCredentialsv1] result = apiInstance.networkCredentialsV1Show(type, connection);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling PropertiesV2Api#propertiesV2Create");
+ System.err.println("Exception when calling NetworkCredentialsV1Api#networkCredentialsV1Show");
e.printStackTrace();
}
}
@@ -26217,67 +27413,59 @@ Usage and SDK Samples
-
+
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
-final String id = new String(); // String | The id of the thing
-final Property property = new Property(); // Property |
-final String xOrganization = new String(); // String | The id of the organization
+final String type = new String(); // String | Device type
+final String connection = new String(); // String | Connection used by the device
try {
- final result = await api_instance.propertiesV2Create(id, property, xOrganization);
+ final result = await api_instance.networkCredentialsV1Show(type, connection);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->propertiesV2Create: $e\n');
+ print('Exception when calling DefaultApi->networkCredentialsV1Show: $e\n');
}
-
- import org.openapitools.client.api.PropertiesV2Api;
+
+ import org.openapitools.client.api.NetworkCredentialsV1Api;
-public class PropertiesV2ApiExample {
+public class NetworkCredentialsV1ApiExample {
public static void main(String[] args) {
- PropertiesV2Api apiInstance = new PropertiesV2Api();
- String id = id_example; // String | The id of the thing
- Property property = ; // Property |
- String xOrganization = xOrganization_example; // String | The id of the organization
+ NetworkCredentialsV1Api apiInstance = new NetworkCredentialsV1Api();
+ String type = type_example; // String | Device type
+ String connection = connection_example; // String | Connection used by the device
try {
- ArduinoProperty result = apiInstance.propertiesV2Create(id, property, xOrganization);
+ array[ArduinoCredentialsv1] result = apiInstance.networkCredentialsV1Show(type, connection);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling PropertiesV2Api#propertiesV2Create");
+ System.err.println("Exception when calling NetworkCredentialsV1Api#networkCredentialsV1Show");
e.printStackTrace();
}
}
}
-
- Configuration *apiConfig = [Configuration sharedConfig];
-
-// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
-[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
-
+
+
// Create an instance of the API class
-PropertiesV2Api *apiInstance = [[PropertiesV2Api alloc] init];
-String *id = id_example; // The id of the thing (default to null)
-Property *property = ; //
-String *xOrganization = xOrganization_example; // The id of the organization (optional) (default to null)
-
-// create properties_v2
-[apiInstance propertiesV2CreateWith:id
- property:property
- xOrganization:xOrganization
- completionHandler: ^(ArduinoProperty output, NSError* error) {
+NetworkCredentialsV1Api *apiInstance = [[NetworkCredentialsV1Api alloc] init];
+String *type = type_example; // Device type (default to null)
+String *connection = connection_example; // Connection used by the device (optional) (default to null)
+
+// show network_credentials_v1
+[apiInstance networkCredentialsV1ShowWith:type
+ connection:connection
+ completionHandler: ^(array[ArduinoCredentialsv1] output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
@@ -26288,22 +27476,16 @@ Usage and SDK Samples
-
+
var ArduinoIotClient = require('@arduino/arduino-iot-client');
-var defaultClient = ArduinoIotClient.ApiClient.instance;
-
-// Configure OAuth2 access token for authorization: oauth2
-var oauth2 = defaultClient.authentications['oauth2'];
-oauth2.accessToken = "YOUR ACCESS TOKEN";
// Create an instance of the API class
-var api = new ArduinoIotClient.PropertiesV2Api()
-var id = id_example; // {String} The id of the thing
-var property = ; // {Property}
+var api = new ArduinoIotClient.NetworkCredentialsV1Api()
+var type = type_example; // {String} Device type
var opts = {
- 'xOrganization': xOrganization_example // {String} The id of the organization
+ 'connection': connection_example // {String} Connection used by the device
};
-api.propertiesV2Create(id, property, opts).then(function(data) {
+api.networkCredentialsV1Show(type, opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
@@ -26312,10 +27494,10 @@ Usage and SDK Samples
-
-
+
using System;
using System.Diagnostics;
using iot.Api;
@@ -26324,25 +27506,22 @@ Usage and SDK Samples
namespace Example
{
- public class propertiesV2CreateExample
+ public class networkCredentialsV1ShowExample
{
public void main()
{
- // Configure OAuth2 access token for authorization: oauth2
- Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
// Create an instance of the API class
- var apiInstance = new PropertiesV2Api();
- var id = id_example; // String | The id of the thing (default to null)
- var property = new Property(); // Property |
- var xOrganization = xOrganization_example; // String | The id of the organization (optional) (default to null)
+ var apiInstance = new NetworkCredentialsV1Api();
+ var type = type_example; // String | Device type (default to null)
+ var connection = connection_example; // String | Connection used by the device (optional) (default to null)
try {
- // create properties_v2
- ArduinoProperty result = apiInstance.propertiesV2Create(id, property, xOrganization);
+ // show network_credentials_v1
+ array[ArduinoCredentialsv1] result = apiInstance.networkCredentialsV1Show(type, connection);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling PropertiesV2Api.propertiesV2Create: " + e.Message );
+ Debug.Print("Exception when calling NetworkCredentialsV1Api.networkCredentialsV1Show: " + e.Message );
}
}
}
@@ -26350,85 +27529,72 @@ Usage and SDK Samples
-
+
<?php
require_once(__DIR__ . '/vendor/autoload.php');
-// Configure OAuth2 access token for authorization: oauth2
-OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
-
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\PropertiesV2Api();
-$id = id_example; // String | The id of the thing
-$property = ; // Property |
-$xOrganization = xOrganization_example; // String | The id of the organization
+$api_instance = new OpenAPITools\Client\Api\NetworkCredentialsV1Api();
+$type = type_example; // String | Device type
+$connection = connection_example; // String | Connection used by the device
try {
- $result = $api_instance->propertiesV2Create($id, $property, $xOrganization);
+ $result = $api_instance->networkCredentialsV1Show($type, $connection);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling PropertiesV2Api->propertiesV2Create: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling NetworkCredentialsV1Api->networkCredentialsV1Show: ', $e->getMessage(), PHP_EOL;
}
?>
-
+
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::PropertiesV2Api;
-
-# Configure OAuth2 access token for authorization: oauth2
-$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+use WWW::OPenAPIClient::NetworkCredentialsV1Api;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::PropertiesV2Api->new();
-my $id = id_example; # String | The id of the thing
-my $property = WWW::OPenAPIClient::Object::Property->new(); # Property |
-my $xOrganization = xOrganization_example; # String | The id of the organization
+my $api_instance = WWW::OPenAPIClient::NetworkCredentialsV1Api->new();
+my $type = type_example; # String | Device type
+my $connection = connection_example; # String | Connection used by the device
eval {
- my $result = $api_instance->propertiesV2Create(id => $id, property => $property, xOrganization => $xOrganization);
+ my $result = $api_instance->networkCredentialsV1Show(type => $type, connection => $connection);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling PropertiesV2Api->propertiesV2Create: $@\n";
+ warn "Exception when calling NetworkCredentialsV1Api->networkCredentialsV1Show: $@\n";
}
-
+
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
-# Configure OAuth2 access token for authorization: oauth2
-openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
-
# Create an instance of the API class
-api_instance = openapi_client.PropertiesV2Api()
-id = id_example # String | The id of the thing (default to null)
-property = # Property |
-xOrganization = xOrganization_example # String | The id of the organization (optional) (default to null)
+api_instance = openapi_client.NetworkCredentialsV1Api()
+type = type_example # String | Device type (default to null)
+connection = connection_example # String | Connection used by the device (optional) (default to null)
try:
- # create properties_v2
- api_response = api_instance.properties_v2_create(id, property, xOrganization=xOrganization)
+ # show network_credentials_v1
+ api_response = api_instance.network_credentials_v1_show(type, connection=connection)
pprint(api_response)
except ApiException as e:
- print("Exception when calling PropertiesV2Api->propertiesV2Create: %s\n" % e)
+ print("Exception when calling NetworkCredentialsV1Api->networkCredentialsV1Show: %s\n" % e)
-
- extern crate PropertiesV2Api;
+
+ extern crate NetworkCredentialsV1Api;
pub fn main() {
- let id = id_example; // String
- let property = ; // Property
- let xOrganization = xOrganization_example; // String
+ let type = type_example; // String
+ let connection = connection_example; // String
- let mut context = PropertiesV2Api::Context::default();
- let result = client.propertiesV2Create(id, property, xOrganization, &context).wait();
+ let mut context = NetworkCredentialsV1Api::Context::default();
+ let result = client.networkCredentialsV1Show(type, connection, &context).wait();
println!("{:?}", result);
}
@@ -26449,11 +27615,11 @@ Parameters
Name
Description
- id*
+ type*
-
+
@@ -26461,7 +27627,7 @@ Parameters
-The id of the thing
+Device type
@@ -26474,17 +27640,20 @@ Parameters
- Header parameters
+
+
+
+ Query parameters
Name
Description
- X-Organization
+ connection
-
+
@@ -26492,7 +27661,7 @@ Parameters
-The id of the organization
+Connection used by the device
@@ -26502,204 +27671,24 @@ Parameters
- Body parameters
-
-
- Name
- Description
-
- property *
-
-PropertyPayload describes a property of a thing. No field is mandatory
-
-
-
-
-
-
-
Responses
-
-
-
-
-
-
- -
- Schema
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- -
- Schema
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
- -
- Schema
-
-
-
+
-
-
-
-
-
-
-
+
-
-
+
+
-
- -
- Schema
-
-
-
+
-
-
-
-
-
-
-
+
-
-
+
+
- propertiesV2Delete
- delete properties_v2
+ networkCredentialsV1ShowByDevice
+ showByDevice network_credentials_v1
- Removes a property associated to a thing
+ Show available connection types depending on device type
- /v2/things/{id}/properties/{pid}
+ /v1/network_credentials/{type}/connections
Usage and SDK Samples
- - Curl
-
-
-
-
-
- - JavaScript
-
-
-
-
-
-
+ - Curl
+
+
+
+
+
+ - JavaScript
+
+
+
+
+
+
-
- curl -X DELETE \
- \
- -H "Accept: application/vnd.goa.error+json,text/plain" \
- "https://api2.arduino.cc/iot/v2/things/{id}/properties/{pid}?force=true"
+
+ curl -X GET \
+ "https://api2.arduino.cc/iot/v1/network_credentials/{type}/connections"
-
+
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
-import org.openapitools.client.api.PropertiesV2Api;
+import org.openapitools.client.api.NetworkCredentialsV1Api;
import java.io.File;
import java.util.*;
-public class PropertiesV2ApiExample {
+public class NetworkCredentialsV1ApiExample {
public static void main(String[] args) {
- ApiClient defaultClient = Configuration.getDefaultApiClient();
-
- // Configure OAuth2 access token for authorization: oauth2
- OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
- oauth2.setAccessToken("YOUR ACCESS TOKEN");
// Create an instance of the API class
- PropertiesV2Api apiInstance = new PropertiesV2Api();
- String id = id_example; // String | The id of the thing
- String pid = pid_example; // String | The id of the property
- Boolean force = true; // Boolean | If true, hard delete the property
- String xOrganization = xOrganization_example; // String | The id of the organization
+ NetworkCredentialsV1Api apiInstance = new NetworkCredentialsV1Api();
+ String type = type_example; // String | Device type
try {
- apiInstance.propertiesV2Delete(id, pid, force, xOrganization);
+ apiInstance.networkCredentialsV1ShowByDevice(type);
} catch (ApiException e) {
- System.err.println("Exception when calling PropertiesV2Api#propertiesV2Delete");
+ System.err.println("Exception when calling NetworkCredentialsV1Api#networkCredentialsV1ShowByDevice");
e.printStackTrace();
}
}
@@ -26969,69 +27846,53 @@ Usage and SDK Samples
-
+
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
-final String id = new String(); // String | The id of the thing
-final String pid = new String(); // String | The id of the property
-final Boolean force = new Boolean(); // Boolean | If true, hard delete the property
-final String xOrganization = new String(); // String | The id of the organization
+final String type = new String(); // String | Device type
try {
- final result = await api_instance.propertiesV2Delete(id, pid, force, xOrganization);
+ final result = await api_instance.networkCredentialsV1ShowByDevice(type);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->propertiesV2Delete: $e\n');
+ print('Exception when calling DefaultApi->networkCredentialsV1ShowByDevice: $e\n');
}
-
- import org.openapitools.client.api.PropertiesV2Api;
+
+ import org.openapitools.client.api.NetworkCredentialsV1Api;
-public class PropertiesV2ApiExample {
+public class NetworkCredentialsV1ApiExample {
public static void main(String[] args) {
- PropertiesV2Api apiInstance = new PropertiesV2Api();
- String id = id_example; // String | The id of the thing
- String pid = pid_example; // String | The id of the property
- Boolean force = true; // Boolean | If true, hard delete the property
- String xOrganization = xOrganization_example; // String | The id of the organization
+ NetworkCredentialsV1Api apiInstance = new NetworkCredentialsV1Api();
+ String type = type_example; // String | Device type
try {
- apiInstance.propertiesV2Delete(id, pid, force, xOrganization);
+ apiInstance.networkCredentialsV1ShowByDevice(type);
} catch (ApiException e) {
- System.err.println("Exception when calling PropertiesV2Api#propertiesV2Delete");
+ System.err.println("Exception when calling NetworkCredentialsV1Api#networkCredentialsV1ShowByDevice");
e.printStackTrace();
}
}
}
-
- Configuration *apiConfig = [Configuration sharedConfig];
-
-// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
-[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
-
+
+
// Create an instance of the API class
-PropertiesV2Api *apiInstance = [[PropertiesV2Api alloc] init];
-String *id = id_example; // The id of the thing (default to null)
-String *pid = pid_example; // The id of the property (default to null)
-Boolean *force = true; // If true, hard delete the property (optional) (default to false)
-String *xOrganization = xOrganization_example; // The id of the organization (optional) (default to null)
+NetworkCredentialsV1Api *apiInstance = [[NetworkCredentialsV1Api alloc] init];
+String *type = type_example; // Device type (default to null)
-// delete properties_v2
-[apiInstance propertiesV2DeleteWith:id
- pid:pid
- force:force
- xOrganization:xOrganization
+// showByDevice network_credentials_v1
+[apiInstance networkCredentialsV1ShowByDeviceWith:type
completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
@@ -27040,23 +27901,13 @@ Usage and SDK Samples
-
+
var ArduinoIotClient = require('@arduino/arduino-iot-client');
-var defaultClient = ArduinoIotClient.ApiClient.instance;
-
-// Configure OAuth2 access token for authorization: oauth2
-var oauth2 = defaultClient.authentications['oauth2'];
-oauth2.accessToken = "YOUR ACCESS TOKEN";
// Create an instance of the API class
-var api = new ArduinoIotClient.PropertiesV2Api()
-var id = id_example; // {String} The id of the thing
-var pid = pid_example; // {String} The id of the property
-var opts = {
- 'force': true, // {Boolean} If true, hard delete the property
- 'xOrganization': xOrganization_example // {String} The id of the organization
-};
-api.propertiesV2Delete(id, pid, opts).then(function() {
+var api = new ArduinoIotClient.NetworkCredentialsV1Api()
+var type = type_example; // {String} Device type
+api.networkCredentialsV1ShowByDevice(type).then(function() {
console.log('API called successfully.');
}, function(error) {
console.error(error);
@@ -27065,10 +27916,10 @@ Usage and SDK Samples
-
-
+
using System;
using System.Diagnostics;
using iot.Api;
@@ -27077,25 +27928,20 @@ Usage and SDK Samples
namespace Example
{
- public class propertiesV2DeleteExample
+ public class networkCredentialsV1ShowByDeviceExample
{
public void main()
{
- // Configure OAuth2 access token for authorization: oauth2
- Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
// Create an instance of the API class
- var apiInstance = new PropertiesV2Api();
- var id = id_example; // String | The id of the thing (default to null)
- var pid = pid_example; // String | The id of the property (default to null)
- var force = true; // Boolean | If true, hard delete the property (optional) (default to false)
- var xOrganization = xOrganization_example; // String | The id of the organization (optional) (default to null)
+ var apiInstance = new NetworkCredentialsV1Api();
+ var type = type_example; // String | Device type (default to null)
try {
- // delete properties_v2
- apiInstance.propertiesV2Delete(id, pid, force, xOrganization);
+ // showByDevice network_credentials_v1
+ apiInstance.networkCredentialsV1ShowByDevice(type);
} catch (Exception e) {
- Debug.Print("Exception when calling PropertiesV2Api.propertiesV2Delete: " + e.Message );
+ Debug.Print("Exception when calling NetworkCredentialsV1Api.networkCredentialsV1ShowByDevice: " + e.Message );
}
}
}
@@ -27103,86 +27949,65 @@ Usage and SDK Samples
-
+
<?php
require_once(__DIR__ . '/vendor/autoload.php');
-// Configure OAuth2 access token for authorization: oauth2
-OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
-
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\PropertiesV2Api();
-$id = id_example; // String | The id of the thing
-$pid = pid_example; // String | The id of the property
-$force = true; // Boolean | If true, hard delete the property
-$xOrganization = xOrganization_example; // String | The id of the organization
+$api_instance = new OpenAPITools\Client\Api\NetworkCredentialsV1Api();
+$type = type_example; // String | Device type
try {
- $api_instance->propertiesV2Delete($id, $pid, $force, $xOrganization);
+ $api_instance->networkCredentialsV1ShowByDevice($type);
} catch (Exception $e) {
- echo 'Exception when calling PropertiesV2Api->propertiesV2Delete: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling NetworkCredentialsV1Api->networkCredentialsV1ShowByDevice: ', $e->getMessage(), PHP_EOL;
}
?>
-
+
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::PropertiesV2Api;
-
-# Configure OAuth2 access token for authorization: oauth2
-$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+use WWW::OPenAPIClient::NetworkCredentialsV1Api;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::PropertiesV2Api->new();
-my $id = id_example; # String | The id of the thing
-my $pid = pid_example; # String | The id of the property
-my $force = true; # Boolean | If true, hard delete the property
-my $xOrganization = xOrganization_example; # String | The id of the organization
+my $api_instance = WWW::OPenAPIClient::NetworkCredentialsV1Api->new();
+my $type = type_example; # String | Device type
eval {
- $api_instance->propertiesV2Delete(id => $id, pid => $pid, force => $force, xOrganization => $xOrganization);
+ $api_instance->networkCredentialsV1ShowByDevice(type => $type);
};
if ($@) {
- warn "Exception when calling PropertiesV2Api->propertiesV2Delete: $@\n";
+ warn "Exception when calling NetworkCredentialsV1Api->networkCredentialsV1ShowByDevice: $@\n";
}
-
+
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
-# Configure OAuth2 access token for authorization: oauth2
-openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
-
# Create an instance of the API class
-api_instance = openapi_client.PropertiesV2Api()
-id = id_example # String | The id of the thing (default to null)
-pid = pid_example # String | The id of the property (default to null)
-force = true # Boolean | If true, hard delete the property (optional) (default to false)
-xOrganization = xOrganization_example # String | The id of the organization (optional) (default to null)
+api_instance = openapi_client.NetworkCredentialsV1Api()
+type = type_example # String | Device type (default to null)
try:
- # delete properties_v2
- api_instance.properties_v2_delete(id, pid, force=force, xOrganization=xOrganization)
+ # showByDevice network_credentials_v1
+ api_instance.network_credentials_v1_show_by_device(type)
except ApiException as e:
- print("Exception when calling PropertiesV2Api->propertiesV2Delete: %s\n" % e)
+ print("Exception when calling NetworkCredentialsV1Api->networkCredentialsV1ShowByDevice: %s\n" % e)
-
- extern crate PropertiesV2Api;
+
+ extern crate NetworkCredentialsV1Api;
pub fn main() {
- let id = id_example; // String
- let pid = pid_example; // String
- let force = true; // Boolean
- let xOrganization = xOrganization_example; // String
+ let type = type_example; // String
- let mut context = PropertiesV2Api::Context::default();
- let result = client.propertiesV2Delete(id, pid, force, xOrganization, &context).wait();
+ let mut context = NetworkCredentialsV1Api::Context::default();
+ let result = client.networkCredentialsV1ShowByDevice(type, &context).wait();
println!("{:?}", result);
}
@@ -27203,34 +28028,11 @@ Parameters
Name
Description
id*
-
-
-
-
-
-
-
- String
-
-
-
-The id of the thing
-
-
-
- Required
-
-
-
-
-pid*
+ type*
-
+
@@ -27238,7 +28040,7 @@ Parameters
-The id of the property
+Device type
@@ -27251,277 +28053,126 @@ Parameters
- Header parameters
-
-
- Name
- Description
-
- X-Organization
-
-
-
-
-
-
-
- String
-
-
-
-The id of the organization
-
-
-
-
-
-
-
-
-
- Query parameters
-
-
- Name
- Description
-
- force
-
-
-
-
-
-
- Boolean
-
-
-If true, hard delete the property
-
-
-
-
-
-
Responses
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
- -
- Schema
-
-
-
+
-
-
-
-
-
-
-
+
-
-
+
+
-
+
-
+
-
-
+
+
-
- -
- Schema
-
-
-
+
-
-
-
-
-
-
-
+
-
-
+
+
+ PropertiesV2
+
+
- propertiesV2List
- list properties_v2
+ propertiesV2Create
+ create properties_v2
- Returns the list of properties associated to the thing
+ Creates a new property associated to a thing
- /v2/things/{id}/properties
+ /v2/things/{id}/properties
Usage and SDK Samples
- - Curl
-
-
-
-
-
- - JavaScript
-
-
-
-
-
-
+ - Curl
+
+
+
+
+
+ - JavaScript
+
+
+
+
+
+
-
- curl -X GET \
+
+ curl -X PUT \
\
- -H "Accept: application/vnd.arduino.property+json; type=collection,application/vnd.goa.error+json" \
- "https://api2.arduino.cc/iot/v2/things/{id}/properties?show_deleted=true"
+ -H "Accept: application/vnd.arduino.property+json,application/vnd.goa.error+json" \
+ -H "Content-Type: application/json,application/x-www-form-urlencoded" \
+ "https://api2.arduino.cc/iot/v2/things/{id}/properties" \
+ -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded'
-
+
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
@@ -27541,14 +28192,14 @@ Usage and SDK Samples
// Create an instance of the API class
PropertiesV2Api apiInstance = new PropertiesV2Api();
String id = id_example; // String | The id of the thing
- Boolean showDeleted = true; // Boolean | If true, shows the soft deleted properties
+ Property property = ; // Property |
String xOrganization = xOrganization_example; // String | The id of the organization
try {
- array[ArduinoProperty] result = apiInstance.propertiesV2List(id, showDeleted, xOrganization);
+ ArduinoProperty result = apiInstance.propertiesV2Create(id, property, xOrganization);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling PropertiesV2Api#propertiesV2List");
+ System.err.println("Exception when calling PropertiesV2Api#propertiesV2Create");
e.printStackTrace();
}
}
@@ -27556,50 +28207,50 @@ Usage and SDK Samples
-
+
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String id = new String(); // String | The id of the thing
-final Boolean showDeleted = new Boolean(); // Boolean | If true, shows the soft deleted properties
+final Property property = new Property(); // Property |
final String xOrganization = new String(); // String | The id of the organization
try {
- final result = await api_instance.propertiesV2List(id, showDeleted, xOrganization);
+ final result = await api_instance.propertiesV2Create(id, property, xOrganization);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->propertiesV2List: $e\n');
+ print('Exception when calling DefaultApi->propertiesV2Create: $e\n');
}
-
+
import org.openapitools.client.api.PropertiesV2Api;
public class PropertiesV2ApiExample {
public static void main(String[] args) {
PropertiesV2Api apiInstance = new PropertiesV2Api();
String id = id_example; // String | The id of the thing
- Boolean showDeleted = true; // Boolean | If true, shows the soft deleted properties
+ Property property = ; // Property |
String xOrganization = xOrganization_example; // String | The id of the organization
try {
- array[ArduinoProperty] result = apiInstance.propertiesV2List(id, showDeleted, xOrganization);
+ ArduinoProperty result = apiInstance.propertiesV2Create(id, property, xOrganization);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling PropertiesV2Api#propertiesV2List");
+ System.err.println("Exception when calling PropertiesV2Api#propertiesV2Create");
e.printStackTrace();
}
}
}
-
+
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
@@ -27609,14 +28260,14 @@ Usage and SDK Samples
// Create an instance of the API class
PropertiesV2Api *apiInstance = [[PropertiesV2Api alloc] init];
String *id = id_example; // The id of the thing (default to null)
-Boolean *showDeleted = true; // If true, shows the soft deleted properties (optional) (default to false)
+Property *property = ; //
String *xOrganization = xOrganization_example; // The id of the organization (optional) (default to null)
-// list properties_v2
-[apiInstance propertiesV2ListWith:id
- showDeleted:showDeleted
+// create properties_v2
+[apiInstance propertiesV2CreateWith:id
+ property:property
xOrganization:xOrganization
- completionHandler: ^(array[ArduinoProperty] output, NSError* error) {
+ completionHandler: ^(ArduinoProperty output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
@@ -27627,7 +28278,7 @@ Usage and SDK Samples
-
+
var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;
@@ -27638,11 +28289,11 @@ Usage and SDK Samples
// Create an instance of the API class
var api = new ArduinoIotClient.PropertiesV2Api()
var id = id_example; // {String} The id of the thing
+var property = ; // {Property}
var opts = {
- 'showDeleted': true, // {Boolean} If true, shows the soft deleted properties
'xOrganization': xOrganization_example // {String} The id of the organization
};
-api.propertiesV2List(id, opts).then(function(data) {
+api.propertiesV2Create(id, property, opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
@@ -27651,10 +28302,10 @@ Usage and SDK Samples
-
-
+
using System;
using System.Diagnostics;
using iot.Api;
@@ -27663,7 +28314,7 @@ Usage and SDK Samples
namespace Example
{
- public class propertiesV2ListExample
+ public class propertiesV2CreateExample
{
public void main()
{
@@ -27673,15 +28324,15 @@ Usage and SDK Samples
// Create an instance of the API class
var apiInstance = new PropertiesV2Api();
var id = id_example; // String | The id of the thing (default to null)
- var showDeleted = true; // Boolean | If true, shows the soft deleted properties (optional) (default to false)
+ var property = new Property(); // Property |
var xOrganization = xOrganization_example; // String | The id of the organization (optional) (default to null)
try {
- // list properties_v2
- array[ArduinoProperty] result = apiInstance.propertiesV2List(id, showDeleted, xOrganization);
+ // create properties_v2
+ ArduinoProperty result = apiInstance.propertiesV2Create(id, property, xOrganization);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling PropertiesV2Api.propertiesV2List: " + e.Message );
+ Debug.Print("Exception when calling PropertiesV2Api.propertiesV2Create: " + e.Message );
}
}
}
@@ -27689,7 +28340,7 @@ Usage and SDK Samples
-
+
<?php
require_once(__DIR__ . '/vendor/autoload.php');
@@ -27699,19 +28350,19 @@ Usage and SDK Samples
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PropertiesV2Api();
$id = id_example; // String | The id of the thing
-$showDeleted = true; // Boolean | If true, shows the soft deleted properties
+$property = ; // Property |
$xOrganization = xOrganization_example; // String | The id of the organization
try {
- $result = $api_instance->propertiesV2List($id, $showDeleted, $xOrganization);
+ $result = $api_instance->propertiesV2Create($id, $property, $xOrganization);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling PropertiesV2Api->propertiesV2List: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling PropertiesV2Api->propertiesV2Create: ', $e->getMessage(), PHP_EOL;
}
?>
-
+
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PropertiesV2Api;
@@ -27722,19 +28373,19 @@ Usage and SDK Samples
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PropertiesV2Api->new();
my $id = id_example; # String | The id of the thing
-my $showDeleted = true; # Boolean | If true, shows the soft deleted properties
+my $property = WWW::OPenAPIClient::Object::Property->new(); # Property |
my $xOrganization = xOrganization_example; # String | The id of the organization
eval {
- my $result = $api_instance->propertiesV2List(id => $id, showDeleted => $showDeleted, xOrganization => $xOrganization);
+ my $result = $api_instance->propertiesV2Create(id => $id, property => $property, xOrganization => $xOrganization);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling PropertiesV2Api->propertiesV2List: $@\n";
+ warn "Exception when calling PropertiesV2Api->propertiesV2Create: $@\n";
}
-
+
from __future__ import print_statement
import time
import openapi_client
@@ -27747,27 +28398,27 @@ Usage and SDK Samples
# Create an instance of the API class
api_instance = openapi_client.PropertiesV2Api()
id = id_example # String | The id of the thing (default to null)
-showDeleted = true # Boolean | If true, shows the soft deleted properties (optional) (default to false)
+property = # Property |
xOrganization = xOrganization_example # String | The id of the organization (optional) (default to null)
try:
- # list properties_v2
- api_response = api_instance.properties_v2_list(id, showDeleted=showDeleted, xOrganization=xOrganization)
+ # create properties_v2
+ api_response = api_instance.properties_v2_create(id, property, xOrganization=xOrganization)
pprint(api_response)
except ApiException as e:
- print("Exception when calling PropertiesV2Api->propertiesV2List: %s\n" % e)
+ print("Exception when calling PropertiesV2Api->propertiesV2Create: %s\n" % e)
-
+
extern crate PropertiesV2Api;
pub fn main() {
let id = id_example; // String
- let showDeleted = true; // Boolean
+ let property = ; // Property
let xOrganization = xOrganization_example; // String
let mut context = PropertiesV2Api::Context::default();
- let result = client.propertiesV2List(id, showDeleted, xOrganization, &context).wait();
+ let result = client.propertiesV2Create(id, property, xOrganization, &context).wait();
println!("{:?}", result);
}
@@ -27792,7 +28443,7 @@ Parameters
-
+
@@ -27823,7 +28474,7 @@ Parameters
-
+
@@ -27841,54 +28492,80 @@ Parameters
-
-
- Query parameters
+ Body parameters
Name
Description
- show_deleted
+ property *
+PropertyPayload describes a property of a thing. No field is mandatory
+
+
+
+
+
+
Responses
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
- propertiesV2Publish
- publish properties_v2
+ propertiesV2Delete
+ delete properties_v2
- Publish a property value to MQTT
+ Removes a property associated to a thing
- /v2/things/{id}/properties/{pid}/publish
+ /v2/things/{id}/properties/{pid}
Usage and SDK Samples
- - Curl
-
-
-
-
-
- - JavaScript
-
-
-
-
-
-
+ - Curl
+
+
+
+
+
+ - JavaScript
+
+
+
+
+
+
-
- curl -X PUT \
+
+ curl -X DELETE \
\
-H "Accept: application/vnd.goa.error+json,text/plain" \
- -H "Content-Type: application/json,application/x-www-form-urlencoded" \
- "https://api2.arduino.cc/iot/v2/things/{id}/properties/{pid}/publish" \
- -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded'
+ "https://api2.arduino.cc/iot/v2/things/{id}/properties/{pid}?force=true"
-
+
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
@@ -28186,13 +28945,13 @@ Usage and SDK Samples
PropertiesV2Api apiInstance = new PropertiesV2Api();
String id = id_example; // String | The id of the thing
String pid = pid_example; // String | The id of the property
- PropertyValue propertyValue = ; // PropertyValue |
+ Boolean force = true; // Boolean | If true, hard delete the property
String xOrganization = xOrganization_example; // String | The id of the organization
try {
- apiInstance.propertiesV2Publish(id, pid, propertyValue, xOrganization);
+ apiInstance.propertiesV2Delete(id, pid, force, xOrganization);
} catch (ApiException e) {
- System.err.println("Exception when calling PropertiesV2Api#propertiesV2Publish");
+ System.err.println("Exception when calling PropertiesV2Api#propertiesV2Delete");
e.printStackTrace();
}
}
@@ -28200,27 +28959,27 @@ Usage and SDK Samples
-
+
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String id = new String(); // String | The id of the thing
final String pid = new String(); // String | The id of the property
-final PropertyValue propertyValue = new PropertyValue(); // PropertyValue |
+final Boolean force = new Boolean(); // Boolean | If true, hard delete the property
final String xOrganization = new String(); // String | The id of the organization
try {
- final result = await api_instance.propertiesV2Publish(id, pid, propertyValue, xOrganization);
+ final result = await api_instance.propertiesV2Delete(id, pid, force, xOrganization);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->propertiesV2Publish: $e\n');
+ print('Exception when calling DefaultApi->propertiesV2Delete: $e\n');
}
-
+
import org.openapitools.client.api.PropertiesV2Api;
public class PropertiesV2ApiExample {
@@ -28228,23 +28987,23 @@ Usage and SDK Samples
PropertiesV2Api apiInstance = new PropertiesV2Api();
String id = id_example; // String | The id of the thing
String pid = pid_example; // String | The id of the property
- PropertyValue propertyValue = ; // PropertyValue |
+ Boolean force = true; // Boolean | If true, hard delete the property
String xOrganization = xOrganization_example; // String | The id of the organization
try {
- apiInstance.propertiesV2Publish(id, pid, propertyValue, xOrganization);
+ apiInstance.propertiesV2Delete(id, pid, force, xOrganization);
} catch (ApiException e) {
- System.err.println("Exception when calling PropertiesV2Api#propertiesV2Publish");
+ System.err.println("Exception when calling PropertiesV2Api#propertiesV2Delete");
e.printStackTrace();
}
}
}
-
+
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
@@ -28255,13 +29014,13 @@ Usage and SDK Samples
PropertiesV2Api *apiInstance = [[PropertiesV2Api alloc] init];
String *id = id_example; // The id of the thing (default to null)
String *pid = pid_example; // The id of the property (default to null)
-PropertyValue *propertyValue = ; //
+Boolean *force = true; // If true, hard delete the property (optional) (default to false)
String *xOrganization = xOrganization_example; // The id of the organization (optional) (default to null)
-// publish properties_v2
-[apiInstance propertiesV2PublishWith:id
+// delete properties_v2
+[apiInstance propertiesV2DeleteWith:id
pid:pid
- propertyValue:propertyValue
+ force:force
xOrganization:xOrganization
completionHandler: ^(NSError* error) {
if (error) {
@@ -28271,7 +29030,7 @@ Usage and SDK Samples
-
+
var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;
@@ -28283,11 +29042,11 @@ Usage and SDK Samples
var api = new ArduinoIotClient.PropertiesV2Api()
var id = id_example; // {String} The id of the thing
var pid = pid_example; // {String} The id of the property
-var propertyValue = ; // {PropertyValue}
var opts = {
+ 'force': true, // {Boolean} If true, hard delete the property
'xOrganization': xOrganization_example // {String} The id of the organization
};
-api.propertiesV2Publish(id, pid, propertyValue, opts).then(function() {
+api.propertiesV2Delete(id, pid, opts).then(function() {
console.log('API called successfully.');
}, function(error) {
console.error(error);
@@ -28296,10 +29055,10 @@ Usage and SDK Samples
-
-
+
using System;
using System.Diagnostics;
using iot.Api;
@@ -28308,7 +29067,7 @@ Usage and SDK Samples
namespace Example
{
- public class propertiesV2PublishExample
+ public class propertiesV2DeleteExample
{
public void main()
{
@@ -28319,14 +29078,14 @@ Usage and SDK Samples
var apiInstance = new PropertiesV2Api();
var id = id_example; // String | The id of the thing (default to null)
var pid = pid_example; // String | The id of the property (default to null)
- var propertyValue = new PropertyValue(); // PropertyValue |
+ var force = true; // Boolean | If true, hard delete the property (optional) (default to false)
var xOrganization = xOrganization_example; // String | The id of the organization (optional) (default to null)
try {
- // publish properties_v2
- apiInstance.propertiesV2Publish(id, pid, propertyValue, xOrganization);
+ // delete properties_v2
+ apiInstance.propertiesV2Delete(id, pid, force, xOrganization);
} catch (Exception e) {
- Debug.Print("Exception when calling PropertiesV2Api.propertiesV2Publish: " + e.Message );
+ Debug.Print("Exception when calling PropertiesV2Api.propertiesV2Delete: " + e.Message );
}
}
}
@@ -28334,7 +29093,7 @@ Usage and SDK Samples
-
+
<?php
require_once(__DIR__ . '/vendor/autoload.php');
@@ -28345,18 +29104,18 @@ Usage and SDK Samples
$api_instance = new OpenAPITools\Client\Api\PropertiesV2Api();
$id = id_example; // String | The id of the thing
$pid = pid_example; // String | The id of the property
-$propertyValue = ; // PropertyValue |
+$force = true; // Boolean | If true, hard delete the property
$xOrganization = xOrganization_example; // String | The id of the organization
try {
- $api_instance->propertiesV2Publish($id, $pid, $propertyValue, $xOrganization);
+ $api_instance->propertiesV2Delete($id, $pid, $force, $xOrganization);
} catch (Exception $e) {
- echo 'Exception when calling PropertiesV2Api->propertiesV2Publish: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling PropertiesV2Api->propertiesV2Delete: ', $e->getMessage(), PHP_EOL;
}
?>
-
+
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PropertiesV2Api;
@@ -28368,18 +29127,18 @@ Usage and SDK Samples
my $api_instance = WWW::OPenAPIClient::PropertiesV2Api->new();
my $id = id_example; # String | The id of the thing
my $pid = pid_example; # String | The id of the property
-my $propertyValue = WWW::OPenAPIClient::Object::PropertyValue->new(); # PropertyValue |
+my $force = true; # Boolean | If true, hard delete the property
my $xOrganization = xOrganization_example; # String | The id of the organization
eval {
- $api_instance->propertiesV2Publish(id => $id, pid => $pid, propertyValue => $propertyValue, xOrganization => $xOrganization);
+ $api_instance->propertiesV2Delete(id => $id, pid => $pid, force => $force, xOrganization => $xOrganization);
};
if ($@) {
- warn "Exception when calling PropertiesV2Api->propertiesV2Publish: $@\n";
+ warn "Exception when calling PropertiesV2Api->propertiesV2Delete: $@\n";
}
-
+
from __future__ import print_statement
import time
import openapi_client
@@ -28393,27 +29152,27 @@ Usage and SDK Samples
api_instance = openapi_client.PropertiesV2Api()
id = id_example # String | The id of the thing (default to null)
pid = pid_example # String | The id of the property (default to null)
-propertyValue = # PropertyValue |
+force = true # Boolean | If true, hard delete the property (optional) (default to false)
xOrganization = xOrganization_example # String | The id of the organization (optional) (default to null)
try:
- # publish properties_v2
- api_instance.properties_v2_publish(id, pid, propertyValue, xOrganization=xOrganization)
+ # delete properties_v2
+ api_instance.properties_v2_delete(id, pid, force=force, xOrganization=xOrganization)
except ApiException as e:
- print("Exception when calling PropertiesV2Api->propertiesV2Publish: %s\n" % e)
+ print("Exception when calling PropertiesV2Api->propertiesV2Delete: %s\n" % e)
-
+
extern crate PropertiesV2Api;
pub fn main() {
let id = id_example; // String
let pid = pid_example; // String
- let propertyValue = ; // PropertyValue
+ let force = true; // Boolean
let xOrganization = xOrganization_example; // String
let mut context = PropertiesV2Api::Context::default();
- let result = client.propertiesV2Publish(id, pid, propertyValue, xOrganization, &context).wait();
+ let result = client.propertiesV2Delete(id, pid, force, xOrganization, &context).wait();
println!("{:?}", result);
}
@@ -28438,7 +29197,7 @@ Parameters
-
+
@@ -28461,7 +29220,7 @@ Parameters
-
+
@@ -28492,7 +29251,7 @@ Parameters
-
+
@@ -28510,102 +29269,76 @@ Parameters
- Body parameters
+
+
+ Query parameters
Name
Description
- propertyValue *
+ force
-PropertyValuePayload describes a property value
-
-
+
+
+
+
+ Boolean
+
+
+
+If true, hard delete the property
+
+
+
+
-
-
Responses
-
-
+
+
-
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
+
+
- propertiesV2Show
- show properties_v2
+ propertiesV2List
+ list properties_v2
- Returns the property requested by the user
+ Returns the list of properties associated to the thing
- /v2/things/{id}/properties/{pid}
+ /v2/things/{id}/properties
Usage and SDK Samples
- - Curl
-
-
-
-
-
- - JavaScript
-
-
-
-
-
-
+ - Curl
+
+
+
+
+
+ - JavaScript
+
+
+
+
+
+
-
+
curl -X GET \
\
- -H "Accept: application/vnd.arduino.property+json,application/vnd.goa.error+json" \
- "https://api2.arduino.cc/iot/v2/things/{id}/properties/{pid}?show_deleted=true"
+ -H "Accept: application/vnd.arduino.property+json; type=collection,application/vnd.goa.error+json" \
+ "https://api2.arduino.cc/iot/v2/things/{id}/properties?show_deleted=true"
-
+
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
@@ -28860,15 +29531,14 @@ Usage and SDK Samples
// Create an instance of the API class
PropertiesV2Api apiInstance = new PropertiesV2Api();
String id = id_example; // String | The id of the thing
- String pid = pid_example; // String | The id of the property
Boolean showDeleted = true; // Boolean | If true, shows the soft deleted properties
String xOrganization = xOrganization_example; // String | The id of the organization
try {
- ArduinoProperty result = apiInstance.propertiesV2Show(id, pid, showDeleted, xOrganization);
+ array[ArduinoProperty] result = apiInstance.propertiesV2List(id, showDeleted, xOrganization);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling PropertiesV2Api#propertiesV2Show");
+ System.err.println("Exception when calling PropertiesV2Api#propertiesV2List");
e.printStackTrace();
}
}
@@ -28876,52 +29546,50 @@ Usage and SDK Samples
-
+
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String id = new String(); // String | The id of the thing
-final String pid = new String(); // String | The id of the property
final Boolean showDeleted = new Boolean(); // Boolean | If true, shows the soft deleted properties
final String xOrganization = new String(); // String | The id of the organization
try {
- final result = await api_instance.propertiesV2Show(id, pid, showDeleted, xOrganization);
+ final result = await api_instance.propertiesV2List(id, showDeleted, xOrganization);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->propertiesV2Show: $e\n');
+ print('Exception when calling DefaultApi->propertiesV2List: $e\n');
}
-
+
import org.openapitools.client.api.PropertiesV2Api;
public class PropertiesV2ApiExample {
public static void main(String[] args) {
PropertiesV2Api apiInstance = new PropertiesV2Api();
String id = id_example; // String | The id of the thing
- String pid = pid_example; // String | The id of the property
Boolean showDeleted = true; // Boolean | If true, shows the soft deleted properties
String xOrganization = xOrganization_example; // String | The id of the organization
try {
- ArduinoProperty result = apiInstance.propertiesV2Show(id, pid, showDeleted, xOrganization);
+ array[ArduinoProperty] result = apiInstance.propertiesV2List(id, showDeleted, xOrganization);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling PropertiesV2Api#propertiesV2Show");
+ System.err.println("Exception when calling PropertiesV2Api#propertiesV2List");
e.printStackTrace();
}
}
}
-
+
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
@@ -28931,16 +29599,14 @@ Usage and SDK Samples
// Create an instance of the API class
PropertiesV2Api *apiInstance = [[PropertiesV2Api alloc] init];
String *id = id_example; // The id of the thing (default to null)
-String *pid = pid_example; // The id of the property (default to null)
Boolean *showDeleted = true; // If true, shows the soft deleted properties (optional) (default to false)
String *xOrganization = xOrganization_example; // The id of the organization (optional) (default to null)
-// show properties_v2
-[apiInstance propertiesV2ShowWith:id
- pid:pid
+// list properties_v2
+[apiInstance propertiesV2ListWith:id
showDeleted:showDeleted
xOrganization:xOrganization
- completionHandler: ^(ArduinoProperty output, NSError* error) {
+ completionHandler: ^(array[ArduinoProperty] output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
@@ -28951,7 +29617,7 @@ Usage and SDK Samples
-
+
var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;
@@ -28962,12 +29628,11 @@ Usage and SDK Samples
// Create an instance of the API class
var api = new ArduinoIotClient.PropertiesV2Api()
var id = id_example; // {String} The id of the thing
-var pid = pid_example; // {String} The id of the property
var opts = {
'showDeleted': true, // {Boolean} If true, shows the soft deleted properties
'xOrganization': xOrganization_example // {String} The id of the organization
};
-api.propertiesV2Show(id, pid, opts).then(function(data) {
+api.propertiesV2List(id, opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
@@ -28976,10 +29641,10 @@ Usage and SDK Samples
-
-
+
using System;
using System.Diagnostics;
using iot.Api;
@@ -28988,7 +29653,7 @@ Usage and SDK Samples
namespace Example
{
- public class propertiesV2ShowExample
+ public class propertiesV2ListExample
{
public void main()
{
@@ -28998,16 +29663,15 @@ Usage and SDK Samples
// Create an instance of the API class
var apiInstance = new PropertiesV2Api();
var id = id_example; // String | The id of the thing (default to null)
- var pid = pid_example; // String | The id of the property (default to null)
var showDeleted = true; // Boolean | If true, shows the soft deleted properties (optional) (default to false)
var xOrganization = xOrganization_example; // String | The id of the organization (optional) (default to null)
try {
- // show properties_v2
- ArduinoProperty result = apiInstance.propertiesV2Show(id, pid, showDeleted, xOrganization);
+ // list properties_v2
+ array[ArduinoProperty] result = apiInstance.propertiesV2List(id, showDeleted, xOrganization);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling PropertiesV2Api.propertiesV2Show: " + e.Message );
+ Debug.Print("Exception when calling PropertiesV2Api.propertiesV2List: " + e.Message );
}
}
}
@@ -29015,7 +29679,7 @@ Usage and SDK Samples
-
+
<?php
require_once(__DIR__ . '/vendor/autoload.php');
@@ -29025,20 +29689,19 @@ Usage and SDK Samples
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PropertiesV2Api();
$id = id_example; // String | The id of the thing
-$pid = pid_example; // String | The id of the property
$showDeleted = true; // Boolean | If true, shows the soft deleted properties
$xOrganization = xOrganization_example; // String | The id of the organization
try {
- $result = $api_instance->propertiesV2Show($id, $pid, $showDeleted, $xOrganization);
+ $result = $api_instance->propertiesV2List($id, $showDeleted, $xOrganization);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling PropertiesV2Api->propertiesV2Show: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling PropertiesV2Api->propertiesV2List: ', $e->getMessage(), PHP_EOL;
}
?>
-
+
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PropertiesV2Api;
@@ -29049,20 +29712,19 @@ Usage and SDK Samples
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PropertiesV2Api->new();
my $id = id_example; # String | The id of the thing
-my $pid = pid_example; # String | The id of the property
my $showDeleted = true; # Boolean | If true, shows the soft deleted properties
my $xOrganization = xOrganization_example; # String | The id of the organization
eval {
- my $result = $api_instance->propertiesV2Show(id => $id, pid => $pid, showDeleted => $showDeleted, xOrganization => $xOrganization);
+ my $result = $api_instance->propertiesV2List(id => $id, showDeleted => $showDeleted, xOrganization => $xOrganization);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling PropertiesV2Api->propertiesV2Show: $@\n";
+ warn "Exception when calling PropertiesV2Api->propertiesV2List: $@\n";
}
-
+
from __future__ import print_statement
import time
import openapi_client
@@ -29075,29 +29737,27 @@ Usage and SDK Samples
# Create an instance of the API class
api_instance = openapi_client.PropertiesV2Api()
id = id_example # String | The id of the thing (default to null)
-pid = pid_example # String | The id of the property (default to null)
showDeleted = true # Boolean | If true, shows the soft deleted properties (optional) (default to false)
xOrganization = xOrganization_example # String | The id of the organization (optional) (default to null)
try:
- # show properties_v2
- api_response = api_instance.properties_v2_show(id, pid, showDeleted=showDeleted, xOrganization=xOrganization)
+ # list properties_v2
+ api_response = api_instance.properties_v2_list(id, showDeleted=showDeleted, xOrganization=xOrganization)
pprint(api_response)
except ApiException as e:
- print("Exception when calling PropertiesV2Api->propertiesV2Show: %s\n" % e)
+ print("Exception when calling PropertiesV2Api->propertiesV2List: %s\n" % e)
-
+
extern crate PropertiesV2Api;
pub fn main() {
let id = id_example; // String
- let pid = pid_example; // String
let showDeleted = true; // Boolean
let xOrganization = xOrganization_example; // String
let mut context = PropertiesV2Api::Context::default();
- let result = client.propertiesV2Show(id, pid, showDeleted, xOrganization, &context).wait();
+ let result = client.propertiesV2List(id, showDeleted, xOrganization, &context).wait();
println!("{:?}", result);
}
@@ -29122,7 +29782,7 @@ Parameters
-
+
@@ -29139,29 +29799,6 @@ Parameters
-
pid*
-
-
-
-
-
-
-
- String
-
-
-
-The id of the property
-
-
-
- Required
-
-
-
-
Parameters
-
+
@@ -29206,7 +29843,7 @@ Parameters
-
+
@@ -29225,23 +29862,23 @@ Parameters
Responses
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
- propertiesV2Timeseries
- timeseries properties_v2
+ propertiesV2Publish
+ publish properties_v2
- Get numerical property's historic data binned on a specified time interval (note: the total number of data points should NOT be greater than 1000 otherwise the result will be truncated)
+ Publish a property value to MQTT
- /v2/things/{id}/properties/{pid}/timeseries
+ /v2/things/{id}/properties/{pid}/publish
Usage and SDK Samples
- - Curl
-
-
-
-
-
- - JavaScript
-
-
-
-
-
-
+ - Curl
+
+
+
+
+
+ - JavaScript
+
+
+
+
+
+
-
- curl -X GET \
+
+ curl -X PUT \
\
- -H "Accept: application/vnd.arduino.timeseriesmedia+json,application/vnd.goa.error+json" \
- "https://api2.arduino.cc/iot/v2/things/{id}/properties/{pid}/timeseries?aggregation=aggregation_example&desc=true&from=from_example&interval=56&to=to_example"
+ -H "Accept: application/vnd.goa.error+json,text/plain" \
+ -H "Content-Type: application/json,application/x-www-form-urlencoded" \
+ "https://api2.arduino.cc/iot/v2/things/{id}/properties/{pid}/publish" \
+ -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded'
-
+
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
@@ -29536,19 +30175,14 @@ Usage and SDK Samples
// Create an instance of the API class
PropertiesV2Api apiInstance = new PropertiesV2Api();
String id = id_example; // String | The id of the thing
- String pid = pid_example; // String | ID of a numerical property
- String aggregation = aggregation_example; // String | Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5
- Boolean desc = true; // Boolean | Whether data's ordering (by time) should be descending
- String from = from_example; // String | Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
- Integer interval = 56; // Integer | Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response)
- String to = to_example; // String | Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+ String pid = pid_example; // String | The id of the property
+ PropertyValue propertyValue = ; // PropertyValue |
String xOrganization = xOrganization_example; // String | The id of the organization
try {
- ArduinoTimeseriesmedia result = apiInstance.propertiesV2Timeseries(id, pid, aggregation, desc, from, interval, to, xOrganization);
- System.out.println(result);
+ apiInstance.propertiesV2Publish(id, pid, propertyValue, xOrganization);
} catch (ApiException e) {
- System.err.println("Exception when calling PropertiesV2Api#propertiesV2Timeseries");
+ System.err.println("Exception when calling PropertiesV2Api#propertiesV2Publish");
e.printStackTrace();
}
}
@@ -29556,60 +30190,51 @@ Usage and SDK Samples
-
+
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String id = new String(); // String | The id of the thing
-final String pid = new String(); // String | ID of a numerical property
-final String aggregation = new String(); // String | Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5
-final Boolean desc = new Boolean(); // Boolean | Whether data's ordering (by time) should be descending
-final String from = new String(); // String | Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
-final Integer interval = new Integer(); // Integer | Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response)
-final String to = new String(); // String | Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+final String pid = new String(); // String | The id of the property
+final PropertyValue propertyValue = new PropertyValue(); // PropertyValue |
final String xOrganization = new String(); // String | The id of the organization
try {
- final result = await api_instance.propertiesV2Timeseries(id, pid, aggregation, desc, from, interval, to, xOrganization);
+ final result = await api_instance.propertiesV2Publish(id, pid, propertyValue, xOrganization);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->propertiesV2Timeseries: $e\n');
+ print('Exception when calling DefaultApi->propertiesV2Publish: $e\n');
}
-
+
import org.openapitools.client.api.PropertiesV2Api;
public class PropertiesV2ApiExample {
public static void main(String[] args) {
PropertiesV2Api apiInstance = new PropertiesV2Api();
String id = id_example; // String | The id of the thing
- String pid = pid_example; // String | ID of a numerical property
- String aggregation = aggregation_example; // String | Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5
- Boolean desc = true; // Boolean | Whether data's ordering (by time) should be descending
- String from = from_example; // String | Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
- Integer interval = 56; // Integer | Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response)
- String to = to_example; // String | Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+ String pid = pid_example; // String | The id of the property
+ PropertyValue propertyValue = ; // PropertyValue |
String xOrganization = xOrganization_example; // String | The id of the organization
try {
- ArduinoTimeseriesmedia result = apiInstance.propertiesV2Timeseries(id, pid, aggregation, desc, from, interval, to, xOrganization);
- System.out.println(result);
+ apiInstance.propertiesV2Publish(id, pid, propertyValue, xOrganization);
} catch (ApiException e) {
- System.err.println("Exception when calling PropertiesV2Api#propertiesV2Timeseries");
+ System.err.println("Exception when calling PropertiesV2Api#propertiesV2Publish");
e.printStackTrace();
}
}
}
-
+
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
@@ -29619,27 +30244,16 @@ Usage and SDK Samples
// Create an instance of the API class
PropertiesV2Api *apiInstance = [[PropertiesV2Api alloc] init];
String *id = id_example; // The id of the thing (default to null)
-String *pid = pid_example; // ID of a numerical property (default to null)
-String *aggregation = aggregation_example; // Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5 (optional) (default to null)
-Boolean *desc = true; // Whether data's ordering (by time) should be descending (optional) (default to false)
-String *from = from_example; // Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z) (optional) (default to null)
-Integer *interval = 56; // Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response) (optional) (default to null)
-String *to = to_example; // Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z) (optional) (default to null)
+String *pid = pid_example; // The id of the property (default to null)
+PropertyValue *propertyValue = ; //
String *xOrganization = xOrganization_example; // The id of the organization (optional) (default to null)
-// timeseries properties_v2
-[apiInstance propertiesV2TimeseriesWith:id
+// publish properties_v2
+[apiInstance propertiesV2PublishWith:id
pid:pid
- aggregation:aggregation
- desc:desc
- from:from
- interval:interval
- to:to
+ propertyValue:propertyValue
xOrganization:xOrganization
- completionHandler: ^(ArduinoTimeseriesmedia output, NSError* error) {
- if (output) {
- NSLog(@"%@", output);
- }
+ completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
@@ -29647,7 +30261,7 @@ Usage and SDK Samples
-
+
var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;
@@ -29658,17 +30272,13 @@ Usage and SDK Samples
// Create an instance of the API class
var api = new ArduinoIotClient.PropertiesV2Api()
var id = id_example; // {String} The id of the thing
-var pid = pid_example; // {String} ID of a numerical property
+var pid = pid_example; // {String} The id of the property
+var propertyValue = ; // {PropertyValue}
var opts = {
- 'aggregation': aggregation_example, // {String} Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5
- 'desc': true, // {Boolean} Whether data's ordering (by time) should be descending
- 'from': from_example, // {String} Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
- 'interval': 56, // {Integer} Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response)
- 'to': to_example, // {String} Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
'xOrganization': xOrganization_example // {String} The id of the organization
};
-api.propertiesV2Timeseries(id, pid, opts).then(function(data) {
- console.log('API called successfully. Returned data: ' + data);
+api.propertiesV2Publish(id, pid, propertyValue, opts).then(function() {
+ console.log('API called successfully.');
}, function(error) {
console.error(error);
});
@@ -29676,10 +30286,10 @@ Usage and SDK Samples
-
-
+
using System;
using System.Diagnostics;
using iot.Api;
@@ -29688,7 +30298,7 @@ Usage and SDK Samples
namespace Example
{
- public class propertiesV2TimeseriesExample
+ public class propertiesV2PublishExample
{
public void main()
{
@@ -29698,20 +30308,15 @@ Usage and SDK Samples
// Create an instance of the API class
var apiInstance = new PropertiesV2Api();
var id = id_example; // String | The id of the thing (default to null)
- var pid = pid_example; // String | ID of a numerical property (default to null)
- var aggregation = aggregation_example; // String | Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5 (optional) (default to null)
- var desc = true; // Boolean | Whether data's ordering (by time) should be descending (optional) (default to false)
- var from = from_example; // String | Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z) (optional) (default to null)
- var interval = 56; // Integer | Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response) (optional) (default to null)
- var to = to_example; // String | Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z) (optional) (default to null)
+ var pid = pid_example; // String | The id of the property (default to null)
+ var propertyValue = new PropertyValue(); // PropertyValue |
var xOrganization = xOrganization_example; // String | The id of the organization (optional) (default to null)
try {
- // timeseries properties_v2
- ArduinoTimeseriesmedia result = apiInstance.propertiesV2Timeseries(id, pid, aggregation, desc, from, interval, to, xOrganization);
- Debug.WriteLine(result);
+ // publish properties_v2
+ apiInstance.propertiesV2Publish(id, pid, propertyValue, xOrganization);
} catch (Exception e) {
- Debug.Print("Exception when calling PropertiesV2Api.propertiesV2Timeseries: " + e.Message );
+ Debug.Print("Exception when calling PropertiesV2Api.propertiesV2Publish: " + e.Message );
}
}
}
@@ -29719,7 +30324,7 @@ Usage and SDK Samples
-
+
<?php
require_once(__DIR__ . '/vendor/autoload.php');
@@ -29729,24 +30334,19 @@ Usage and SDK Samples
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PropertiesV2Api();
$id = id_example; // String | The id of the thing
-$pid = pid_example; // String | ID of a numerical property
-$aggregation = aggregation_example; // String | Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5
-$desc = true; // Boolean | Whether data's ordering (by time) should be descending
-$from = from_example; // String | Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
-$interval = 56; // Integer | Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response)
-$to = to_example; // String | Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+$pid = pid_example; // String | The id of the property
+$propertyValue = ; // PropertyValue |
$xOrganization = xOrganization_example; // String | The id of the organization
try {
- $result = $api_instance->propertiesV2Timeseries($id, $pid, $aggregation, $desc, $from, $interval, $to, $xOrganization);
- print_r($result);
+ $api_instance->propertiesV2Publish($id, $pid, $propertyValue, $xOrganization);
} catch (Exception $e) {
- echo 'Exception when calling PropertiesV2Api->propertiesV2Timeseries: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling PropertiesV2Api->propertiesV2Publish: ', $e->getMessage(), PHP_EOL;
}
?>
-
+
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PropertiesV2Api;
@@ -29757,24 +30357,19 @@ Usage and SDK Samples
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PropertiesV2Api->new();
my $id = id_example; # String | The id of the thing
-my $pid = pid_example; # String | ID of a numerical property
-my $aggregation = aggregation_example; # String | Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5
-my $desc = true; # Boolean | Whether data's ordering (by time) should be descending
-my $from = from_example; # String | Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
-my $interval = 56; # Integer | Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response)
-my $to = to_example; # String | Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+my $pid = pid_example; # String | The id of the property
+my $propertyValue = WWW::OPenAPIClient::Object::PropertyValue->new(); # PropertyValue |
my $xOrganization = xOrganization_example; # String | The id of the organization
eval {
- my $result = $api_instance->propertiesV2Timeseries(id => $id, pid => $pid, aggregation => $aggregation, desc => $desc, from => $from, interval => $interval, to => $to, xOrganization => $xOrganization);
- print Dumper($result);
+ $api_instance->propertiesV2Publish(id => $id, pid => $pid, propertyValue => $propertyValue, xOrganization => $xOrganization);
};
if ($@) {
- warn "Exception when calling PropertiesV2Api->propertiesV2Timeseries: $@\n";
+ warn "Exception when calling PropertiesV2Api->propertiesV2Publish: $@\n";
}
-
+
from __future__ import print_statement
import time
import openapi_client
@@ -29787,37 +30382,28 @@ Usage and SDK Samples
# Create an instance of the API class
api_instance = openapi_client.PropertiesV2Api()
id = id_example # String | The id of the thing (default to null)
-pid = pid_example # String | ID of a numerical property (default to null)
-aggregation = aggregation_example # String | Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5 (optional) (default to null)
-desc = true # Boolean | Whether data's ordering (by time) should be descending (optional) (default to false)
-from = from_example # String | Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z) (optional) (default to null)
-interval = 56 # Integer | Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response) (optional) (default to null)
-to = to_example # String | Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z) (optional) (default to null)
+pid = pid_example # String | The id of the property (default to null)
+propertyValue = # PropertyValue |
xOrganization = xOrganization_example # String | The id of the organization (optional) (default to null)
try:
- # timeseries properties_v2
- api_response = api_instance.properties_v2_timeseries(id, pid, aggregation=aggregation, desc=desc, from=from, interval=interval, to=to, xOrganization=xOrganization)
- pprint(api_response)
+ # publish properties_v2
+ api_instance.properties_v2_publish(id, pid, propertyValue, xOrganization=xOrganization)
except ApiException as e:
- print("Exception when calling PropertiesV2Api->propertiesV2Timeseries: %s\n" % e)
+ print("Exception when calling PropertiesV2Api->propertiesV2Publish: %s\n" % e)
-
+
extern crate PropertiesV2Api;
pub fn main() {
let id = id_example; // String
let pid = pid_example; // String
- let aggregation = aggregation_example; // String
- let desc = true; // Boolean
- let from = from_example; // String
- let interval = 56; // Integer
- let to = to_example; // String
+ let propertyValue = ; // PropertyValue
let xOrganization = xOrganization_example; // String
let mut context = PropertiesV2Api::Context::default();
- let result = client.propertiesV2Timeseries(id, pid, aggregation, desc, from, interval, to, xOrganization, &context).wait();
+ let result = client.propertiesV2Publish(id, pid, propertyValue, xOrganization, &context).wait();
println!("{:?}", result);
}
@@ -29842,7 +30428,7 @@ Parameters
-
+
@@ -29865,7 +30451,7 @@ Parameters
-
+
@@ -29873,7 +30459,7 @@ Parameters
-ID of a numerical property
+The id of the property
@@ -29896,7 +30482,7 @@ Parameters
-
+
@@ -29914,134 +30500,102 @@ Parameters
-
-
- Query parameters
+ Body parameters
Name
Description
- aggregation
-
-
-
-
-
-
-
- String
-
-
-
-Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5
-
-
-
-
-
-desc
-
-
-
-
-
-
-
- Boolean
-
-
-
-Whether data's ordering (by time) should be descending
-
-
-
-
-
-from
+ propertyValue *
+PropertyValuePayload describes a property value
+
+
interval
-
+
-
-
-
-
- Integer
-
-
-Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response)
-
-
-
-
-
-
+ Responses
+
+
+
- to
-
+
-
-
-
-
- String
-
-
-Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
-
-
-
-
-
-Responses
-
-
+
+
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ propertiesV2Show
+ show properties_v2
+
+
+
+
+ Returns the property requested by the user
+
+
+ /v2/things/{id}/properties/{pid}
+
+
Usage and SDK Samples
+
+
+ - Curl
+
+
+
+
+
+ - JavaScript
+
+
+
+
+
+
+
+
+
+
+ curl -X GET \
+ \
+ -H "Accept: application/vnd.arduino.property+json,application/vnd.goa.error+json" \
+ "https://api2.arduino.cc/iot/v2/things/{id}/properties/{pid}?show_deleted=true"
+
+
+
+ import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.PropertiesV2Api;
+
+import java.io.File;
+import java.util.*;
+
+public class PropertiesV2ApiExample {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+
+ // Configure OAuth2 access token for authorization: oauth2
+ OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
+ oauth2.setAccessToken("YOUR ACCESS TOKEN");
+
+ // Create an instance of the API class
+ PropertiesV2Api apiInstance = new PropertiesV2Api();
+ String id = id_example; // String | The id of the thing
+ String pid = pid_example; // String | The id of the property
+ Boolean showDeleted = true; // Boolean | If true, shows the soft deleted properties
+ String xOrganization = xOrganization_example; // String | The id of the organization
+
+ try {
+ ArduinoProperty result = apiInstance.propertiesV2Show(id, pid, showDeleted, xOrganization);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling PropertiesV2Api#propertiesV2Show");
+ e.printStackTrace();
+ }
+ }
+}
+
+
+
+
+ import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String id = new String(); // String | The id of the thing
+final String pid = new String(); // String | The id of the property
+final Boolean showDeleted = new Boolean(); // Boolean | If true, shows the soft deleted properties
+final String xOrganization = new String(); // String | The id of the organization
+
+try {
+ final result = await api_instance.propertiesV2Show(id, pid, showDeleted, xOrganization);
+ print(result);
+} catch (e) {
+ print('Exception when calling DefaultApi->propertiesV2Show: $e\n');
+}
+
+
+
+
+
+ import org.openapitools.client.api.PropertiesV2Api;
+
+public class PropertiesV2ApiExample {
+ public static void main(String[] args) {
+ PropertiesV2Api apiInstance = new PropertiesV2Api();
+ String id = id_example; // String | The id of the thing
+ String pid = pid_example; // String | The id of the property
+ Boolean showDeleted = true; // Boolean | If true, shows the soft deleted properties
+ String xOrganization = xOrganization_example; // String | The id of the organization
+
+ try {
+ ArduinoProperty result = apiInstance.propertiesV2Show(id, pid, showDeleted, xOrganization);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling PropertiesV2Api#propertiesV2Show");
+ e.printStackTrace();
+ }
+ }
+}
+
+
+
+ Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
+[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
+
+
+// Create an instance of the API class
+PropertiesV2Api *apiInstance = [[PropertiesV2Api alloc] init];
+String *id = id_example; // The id of the thing (default to null)
+String *pid = pid_example; // The id of the property (default to null)
+Boolean *showDeleted = true; // If true, shows the soft deleted properties (optional) (default to false)
+String *xOrganization = xOrganization_example; // The id of the organization (optional) (default to null)
+
+// show properties_v2
+[apiInstance propertiesV2ShowWith:id
+ pid:pid
+ showDeleted:showDeleted
+ xOrganization:xOrganization
+ completionHandler: ^(ArduinoProperty output, NSError* error) {
+ if (output) {
+ NSLog(@"%@", output);
+ }
+ if (error) {
+ NSLog(@"Error: %@", error);
+ }
+}];
+
+
+
+
+ var ArduinoIotClient = require('@arduino/arduino-iot-client');
+var defaultClient = ArduinoIotClient.ApiClient.instance;
+
+// Configure OAuth2 access token for authorization: oauth2
+var oauth2 = defaultClient.authentications['oauth2'];
+oauth2.accessToken = "YOUR ACCESS TOKEN";
+
+// Create an instance of the API class
+var api = new ArduinoIotClient.PropertiesV2Api()
+var id = id_example; // {String} The id of the thing
+var pid = pid_example; // {String} The id of the property
+var opts = {
+ 'showDeleted': true, // {Boolean} If true, shows the soft deleted properties
+ 'xOrganization': xOrganization_example // {String} The id of the organization
+};
+api.propertiesV2Show(id, pid, opts).then(function(data) {
+ console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+ console.error(error);
+});
+
+
+
+
+
+
+ using System;
+using System.Diagnostics;
+using iot.Api;
+using iot.Client;
+using iot.Model;
+
+namespace Example
+{
+ public class propertiesV2ShowExample
+ {
+ public void main()
+ {
+ // Configure OAuth2 access token for authorization: oauth2
+ Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
+
+ // Create an instance of the API class
+ var apiInstance = new PropertiesV2Api();
+ var id = id_example; // String | The id of the thing (default to null)
+ var pid = pid_example; // String | The id of the property (default to null)
+ var showDeleted = true; // Boolean | If true, shows the soft deleted properties (optional) (default to false)
+ var xOrganization = xOrganization_example; // String | The id of the organization (optional) (default to null)
+
+ try {
+ // show properties_v2
+ ArduinoProperty result = apiInstance.propertiesV2Show(id, pid, showDeleted, xOrganization);
+ Debug.WriteLine(result);
+ } catch (Exception e) {
+ Debug.Print("Exception when calling PropertiesV2Api.propertiesV2Show: " + e.Message );
+ }
+ }
+ }
+}
+
+
+
+
+ <?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure OAuth2 access token for authorization: oauth2
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\PropertiesV2Api();
+$id = id_example; // String | The id of the thing
+$pid = pid_example; // String | The id of the property
+$showDeleted = true; // Boolean | If true, shows the soft deleted properties
+$xOrganization = xOrganization_example; // String | The id of the organization
+
+try {
+ $result = $api_instance->propertiesV2Show($id, $pid, $showDeleted, $xOrganization);
+ print_r($result);
+} catch (Exception $e) {
+ echo 'Exception when calling PropertiesV2Api->propertiesV2Show: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+
+
+ use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::PropertiesV2Api;
+
+# Configure OAuth2 access token for authorization: oauth2
+$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::PropertiesV2Api->new();
+my $id = id_example; # String | The id of the thing
+my $pid = pid_example; # String | The id of the property
+my $showDeleted = true; # Boolean | If true, shows the soft deleted properties
+my $xOrganization = xOrganization_example; # String | The id of the organization
+
+eval {
+ my $result = $api_instance->propertiesV2Show(id => $id, pid => $pid, showDeleted => $showDeleted, xOrganization => $xOrganization);
+ print Dumper($result);
+};
+if ($@) {
+ warn "Exception when calling PropertiesV2Api->propertiesV2Show: $@\n";
+}
+
+
+
+ from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: oauth2
+openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# Create an instance of the API class
+api_instance = openapi_client.PropertiesV2Api()
+id = id_example # String | The id of the thing (default to null)
+pid = pid_example # String | The id of the property (default to null)
+showDeleted = true # Boolean | If true, shows the soft deleted properties (optional) (default to false)
+xOrganization = xOrganization_example # String | The id of the organization (optional) (default to null)
+
+try:
+ # show properties_v2
+ api_response = api_instance.properties_v2_show(id, pid, showDeleted=showDeleted, xOrganization=xOrganization)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling PropertiesV2Api->propertiesV2Show: %s\n" % e)
+
+
+
+ extern crate PropertiesV2Api;
+
+pub fn main() {
+ let id = id_example; // String
+ let pid = pid_example; // String
+ let showDeleted = true; // Boolean
+ let xOrganization = xOrganization_example; // String
+
+ let mut context = PropertiesV2Api::Context::default();
+ let result = client.propertiesV2Show(id, pid, showDeleted, xOrganization, &context).wait();
+
+ println!("{:?}", result);
+}
+
+
+
+
+ Scopes
+
+
+
+
+ Parameters
+
+ Path parameters
+
+
+ Name
+ Description
+
+ id*
+
+
+
+
+
+
+
+ String
+
+
+
+The id of the thing
+
+
+
+ Required
+
+
+
+
+pid*
+
+
+
+
+
+
+
+ String
+
+
+
+The id of the property
+
+
+
+ Required
+
+
+
+
+
+
+ Header parameters
+
+
+ Name
+ Description
+
+ X-Organization
+
+
+
+
+
+
+
+ String
+
+
+
+The id of the organization
+
+
+
+
+
+
+
+
+
+ Query parameters
+
+
+ Name
+ Description
+
+ show_deleted
+
+
+
+
+
+
+
+ Boolean
+
+
+
+If true, shows the soft deleted properties
+
+
+
+
+
+
+
+ Responses
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ propertiesV2Timeseries
+ timeseries properties_v2
+
+
+
+
+ Get numerical property's historic data binned on a specified time interval (note: the total number of data points should NOT be greater than 1000 otherwise the result will be truncated)
+
+
+ /v2/things/{id}/properties/{pid}/timeseries
+
+
Usage and SDK Samples
+
+
+ - Curl
+
+
+
+
+
+ - JavaScript
+
+
+
+
+
+
+
+
+
+
+ curl -X GET \
+ \
+ -H "Accept: application/vnd.arduino.timeseriesmedia+json,application/vnd.goa.error+json" \
+ "https://api2.arduino.cc/iot/v2/things/{id}/properties/{pid}/timeseries?aggregation=aggregation_example&desc=true&from=from_example&interval=56&to=to_example"
+
+
+
+ import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.PropertiesV2Api;
+
+import java.io.File;
+import java.util.*;
+
+public class PropertiesV2ApiExample {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+
+ // Configure OAuth2 access token for authorization: oauth2
+ OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
+ oauth2.setAccessToken("YOUR ACCESS TOKEN");
+
+ // Create an instance of the API class
+ PropertiesV2Api apiInstance = new PropertiesV2Api();
+ String id = id_example; // String | The id of the thing
+ String pid = pid_example; // String | ID of a numerical property
+ String aggregation = aggregation_example; // String | Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5
+ Boolean desc = true; // Boolean | Whether data's ordering (by time) should be descending
+ String from = from_example; // String | Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+ Integer interval = 56; // Integer | Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response)
+ String to = to_example; // String | Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+ String xOrganization = xOrganization_example; // String | The id of the organization
+
+ try {
+ ArduinoTimeseriesmedia result = apiInstance.propertiesV2Timeseries(id, pid, aggregation, desc, from, interval, to, xOrganization);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling PropertiesV2Api#propertiesV2Timeseries");
+ e.printStackTrace();
+ }
+ }
+}
+
+
+
+
+ import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String id = new String(); // String | The id of the thing
+final String pid = new String(); // String | ID of a numerical property
+final String aggregation = new String(); // String | Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5
+final Boolean desc = new Boolean(); // Boolean | Whether data's ordering (by time) should be descending
+final String from = new String(); // String | Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+final Integer interval = new Integer(); // Integer | Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response)
+final String to = new String(); // String | Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+final String xOrganization = new String(); // String | The id of the organization
+
+try {
+ final result = await api_instance.propertiesV2Timeseries(id, pid, aggregation, desc, from, interval, to, xOrganization);
+ print(result);
+} catch (e) {
+ print('Exception when calling DefaultApi->propertiesV2Timeseries: $e\n');
+}
+
+
+
+
+
+ import org.openapitools.client.api.PropertiesV2Api;
+
+public class PropertiesV2ApiExample {
+ public static void main(String[] args) {
+ PropertiesV2Api apiInstance = new PropertiesV2Api();
+ String id = id_example; // String | The id of the thing
+ String pid = pid_example; // String | ID of a numerical property
+ String aggregation = aggregation_example; // String | Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5
+ Boolean desc = true; // Boolean | Whether data's ordering (by time) should be descending
+ String from = from_example; // String | Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+ Integer interval = 56; // Integer | Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response)
+ String to = to_example; // String | Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+ String xOrganization = xOrganization_example; // String | The id of the organization
+
+ try {
+ ArduinoTimeseriesmedia result = apiInstance.propertiesV2Timeseries(id, pid, aggregation, desc, from, interval, to, xOrganization);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling PropertiesV2Api#propertiesV2Timeseries");
+ e.printStackTrace();
+ }
+ }
+}
+
+
+
+ Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
+[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
+
+
+// Create an instance of the API class
+PropertiesV2Api *apiInstance = [[PropertiesV2Api alloc] init];
+String *id = id_example; // The id of the thing (default to null)
+String *pid = pid_example; // ID of a numerical property (default to null)
+String *aggregation = aggregation_example; // Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5 (optional) (default to null)
+Boolean *desc = true; // Whether data's ordering (by time) should be descending (optional) (default to false)
+String *from = from_example; // Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z) (optional) (default to null)
+Integer *interval = 56; // Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response) (optional) (default to null)
+String *to = to_example; // Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z) (optional) (default to null)
+String *xOrganization = xOrganization_example; // The id of the organization (optional) (default to null)
+
+// timeseries properties_v2
+[apiInstance propertiesV2TimeseriesWith:id
+ pid:pid
+ aggregation:aggregation
+ desc:desc
+ from:from
+ interval:interval
+ to:to
+ xOrganization:xOrganization
+ completionHandler: ^(ArduinoTimeseriesmedia output, NSError* error) {
+ if (output) {
+ NSLog(@"%@", output);
+ }
+ if (error) {
+ NSLog(@"Error: %@", error);
+ }
+}];
+
+
+
+
+ var ArduinoIotClient = require('@arduino/arduino-iot-client');
+var defaultClient = ArduinoIotClient.ApiClient.instance;
+
+// Configure OAuth2 access token for authorization: oauth2
+var oauth2 = defaultClient.authentications['oauth2'];
+oauth2.accessToken = "YOUR ACCESS TOKEN";
+
+// Create an instance of the API class
+var api = new ArduinoIotClient.PropertiesV2Api()
+var id = id_example; // {String} The id of the thing
+var pid = pid_example; // {String} ID of a numerical property
+var opts = {
+ 'aggregation': aggregation_example, // {String} Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5
+ 'desc': true, // {Boolean} Whether data's ordering (by time) should be descending
+ 'from': from_example, // {String} Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+ 'interval': 56, // {Integer} Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response)
+ 'to': to_example, // {String} Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+ 'xOrganization': xOrganization_example // {String} The id of the organization
+};
+api.propertiesV2Timeseries(id, pid, opts).then(function(data) {
+ console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+ console.error(error);
+});
+
+
+
+
+
+
+ using System;
+using System.Diagnostics;
+using iot.Api;
+using iot.Client;
+using iot.Model;
+
+namespace Example
+{
+ public class propertiesV2TimeseriesExample
+ {
+ public void main()
+ {
+ // Configure OAuth2 access token for authorization: oauth2
+ Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
+
+ // Create an instance of the API class
+ var apiInstance = new PropertiesV2Api();
+ var id = id_example; // String | The id of the thing (default to null)
+ var pid = pid_example; // String | ID of a numerical property (default to null)
+ var aggregation = aggregation_example; // String | Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5 (optional) (default to null)
+ var desc = true; // Boolean | Whether data's ordering (by time) should be descending (optional) (default to false)
+ var from = from_example; // String | Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z) (optional) (default to null)
+ var interval = 56; // Integer | Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response) (optional) (default to null)
+ var to = to_example; // String | Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z) (optional) (default to null)
+ var xOrganization = xOrganization_example; // String | The id of the organization (optional) (default to null)
+
+ try {
+ // timeseries properties_v2
+ ArduinoTimeseriesmedia result = apiInstance.propertiesV2Timeseries(id, pid, aggregation, desc, from, interval, to, xOrganization);
+ Debug.WriteLine(result);
+ } catch (Exception e) {
+ Debug.Print("Exception when calling PropertiesV2Api.propertiesV2Timeseries: " + e.Message );
+ }
+ }
+ }
+}
+
+
+
+
+ <?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure OAuth2 access token for authorization: oauth2
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\PropertiesV2Api();
+$id = id_example; // String | The id of the thing
+$pid = pid_example; // String | ID of a numerical property
+$aggregation = aggregation_example; // String | Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5
+$desc = true; // Boolean | Whether data's ordering (by time) should be descending
+$from = from_example; // String | Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+$interval = 56; // Integer | Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response)
+$to = to_example; // String | Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+$xOrganization = xOrganization_example; // String | The id of the organization
+
+try {
+ $result = $api_instance->propertiesV2Timeseries($id, $pid, $aggregation, $desc, $from, $interval, $to, $xOrganization);
+ print_r($result);
+} catch (Exception $e) {
+ echo 'Exception when calling PropertiesV2Api->propertiesV2Timeseries: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+
+
+ use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::PropertiesV2Api;
+
+# Configure OAuth2 access token for authorization: oauth2
+$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::PropertiesV2Api->new();
+my $id = id_example; # String | The id of the thing
+my $pid = pid_example; # String | ID of a numerical property
+my $aggregation = aggregation_example; # String | Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5
+my $desc = true; # Boolean | Whether data's ordering (by time) should be descending
+my $from = from_example; # String | Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+my $interval = 56; # Integer | Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response)
+my $to = to_example; # String | Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+my $xOrganization = xOrganization_example; # String | The id of the organization
+
+eval {
+ my $result = $api_instance->propertiesV2Timeseries(id => $id, pid => $pid, aggregation => $aggregation, desc => $desc, from => $from, interval => $interval, to => $to, xOrganization => $xOrganization);
+ print Dumper($result);
+};
+if ($@) {
+ warn "Exception when calling PropertiesV2Api->propertiesV2Timeseries: $@\n";
+}
+
+
+
+ from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: oauth2
+openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# Create an instance of the API class
+api_instance = openapi_client.PropertiesV2Api()
+id = id_example # String | The id of the thing (default to null)
+pid = pid_example # String | ID of a numerical property (default to null)
+aggregation = aggregation_example # String | Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5 (optional) (default to null)
+desc = true # Boolean | Whether data's ordering (by time) should be descending (optional) (default to false)
+from = from_example # String | Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z) (optional) (default to null)
+interval = 56 # Integer | Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response) (optional) (default to null)
+to = to_example # String | Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z) (optional) (default to null)
+xOrganization = xOrganization_example # String | The id of the organization (optional) (default to null)
+
+try:
+ # timeseries properties_v2
+ api_response = api_instance.properties_v2_timeseries(id, pid, aggregation=aggregation, desc=desc, from=from, interval=interval, to=to, xOrganization=xOrganization)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling PropertiesV2Api->propertiesV2Timeseries: %s\n" % e)
+
+
+
+ extern crate PropertiesV2Api;
+
+pub fn main() {
+ let id = id_example; // String
+ let pid = pid_example; // String
+ let aggregation = aggregation_example; // String
+ let desc = true; // Boolean
+ let from = from_example; // String
+ let interval = 56; // Integer
+ let to = to_example; // String
+ let xOrganization = xOrganization_example; // String
+
+ let mut context = PropertiesV2Api::Context::default();
+ let result = client.propertiesV2Timeseries(id, pid, aggregation, desc, from, interval, to, xOrganization, &context).wait();
+
+ println!("{:?}", result);
+}
+
+
+
+
+ Scopes
+
+
+
+
+ Parameters
+
+ Path parameters
+
+
+ Name
+ Description
+
+ id*
+
+
+
+
+
+
+
+ String
+
+
+
+The id of the thing
+
+
+
+ Required
+
+
+
+
+pid*
+
+
+
+
+
+
+
+ String
+
+
+
+ID of a numerical property
+
+
+
+ Required
+
+
+
+
+
+
+ Header parameters
+
+
+ Name
+ Description
+
+ X-Organization
+
+
+
+
+
+
+
+ String
+
+
+
+The id of the organization
+
+
+
+
+
+
+
+
+
+ Query parameters
+
+
+ Name
+ Description
+
+ aggregation
+
+
+
+
+
+
+
+ String
+
+
+
+Samples aggregation statistic. Supported aggregations AVG|MAX|MIN|COUNT|SUM|PCT_99|PCT_95|PCT_90|PCT_75|PCT_50|PCT_15|PCT_5
+
+
+
+
+
+desc
+
+
+
+
+
+
+
+ Boolean
+
+
+
+Whether data's ordering (by time) should be descending
+
+
+
+
+
+from
+
+
+
+
+
+
+
+ String
+
+
+
+Get data with a timestamp >= to this date (default: 2 weeks ago, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+
+
+
+
+
+interval
+
+
+
+
+
+
+
+ Integer
+
+
+
+Binning interval in seconds (defaut: the smallest possible value compatibly with the limit of 1000 data points in the response)
+
+
+
+
+
+to
+
+
+
+
+
+
+
+ String
+
+
+
+Get data with a timestamp < to this date (default: now, min: 1842-01-01T00:00:00Z, max: 2242-01-01T00:00:00Z)
+
+
+
+
+
+
+
+ Responses
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ propertiesV2Update
+ update properties_v2
+
+
+
+
+ Updates a property associated to a thing
+
+
+ /v2/things/{id}/properties/{pid}
+
+
Usage and SDK Samples
+
+
+ - Curl
+
+
+
+
+
+ - JavaScript
+
+
+
+
+
+
+
+
+
+
+ curl -X POST \
+ \
+ -H "Accept: application/vnd.arduino.property+json,application/vnd.goa.error+json" \
+ -H "Content-Type: application/json,application/x-www-form-urlencoded" \
+ "https://api2.arduino.cc/iot/v2/things/{id}/properties/{pid}" \
+ -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded'
+
+
+
+ import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.PropertiesV2Api;
+
+import java.io.File;
+import java.util.*;
+
+public class PropertiesV2ApiExample {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+
+ // Configure OAuth2 access token for authorization: oauth2
+ OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
+ oauth2.setAccessToken("YOUR ACCESS TOKEN");
+
+ // Create an instance of the API class
+ PropertiesV2Api apiInstance = new PropertiesV2Api();
+ String id = id_example; // String | The id of the thing
+ String pid = pid_example; // String | The id of the property
+ Property property = ; // Property |
+ String xOrganization = xOrganization_example; // String | The id of the organization
+
+ try {
+ ArduinoProperty result = apiInstance.propertiesV2Update(id, pid, property, xOrganization);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling PropertiesV2Api#propertiesV2Update");
+ e.printStackTrace();
+ }
+ }
+}
+
+
+
+
+ import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String id = new String(); // String | The id of the thing
+final String pid = new String(); // String | The id of the property
+final Property property = new Property(); // Property |
+final String xOrganization = new String(); // String | The id of the organization
+
+try {
+ final result = await api_instance.propertiesV2Update(id, pid, property, xOrganization);
+ print(result);
+} catch (e) {
+ print('Exception when calling DefaultApi->propertiesV2Update: $e\n');
+}
+
+
+
+
+
+ import org.openapitools.client.api.PropertiesV2Api;
+
+public class PropertiesV2ApiExample {
+ public static void main(String[] args) {
+ PropertiesV2Api apiInstance = new PropertiesV2Api();
+ String id = id_example; // String | The id of the thing
+ String pid = pid_example; // String | The id of the property
+ Property property = ; // Property |
+ String xOrganization = xOrganization_example; // String | The id of the organization
+
+ try {
+ ArduinoProperty result = apiInstance.propertiesV2Update(id, pid, property, xOrganization);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling PropertiesV2Api#propertiesV2Update");
+ e.printStackTrace();
+ }
+ }
+}
+
+
+
+ Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
+[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
+
+
+// Create an instance of the API class
+PropertiesV2Api *apiInstance = [[PropertiesV2Api alloc] init];
+String *id = id_example; // The id of the thing (default to null)
+String *pid = pid_example; // The id of the property (default to null)
+Property *property = ; //
+String *xOrganization = xOrganization_example; // The id of the organization (optional) (default to null)
+
+// update properties_v2
+[apiInstance propertiesV2UpdateWith:id
+ pid:pid
+ property:property
+ xOrganization:xOrganization
+ completionHandler: ^(ArduinoProperty output, NSError* error) {
+ if (output) {
+ NSLog(@"%@", output);
+ }
+ if (error) {
+ NSLog(@"Error: %@", error);
+ }
+}];
+
+
+
+
+ var ArduinoIotClient = require('@arduino/arduino-iot-client');
+var defaultClient = ArduinoIotClient.ApiClient.instance;
+
+// Configure OAuth2 access token for authorization: oauth2
+var oauth2 = defaultClient.authentications['oauth2'];
+oauth2.accessToken = "YOUR ACCESS TOKEN";
+
+// Create an instance of the API class
+var api = new ArduinoIotClient.PropertiesV2Api()
+var id = id_example; // {String} The id of the thing
+var pid = pid_example; // {String} The id of the property
+var property = ; // {Property}
+var opts = {
+ 'xOrganization': xOrganization_example // {String} The id of the organization
+};
+api.propertiesV2Update(id, pid, property, opts).then(function(data) {
+ console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+ console.error(error);
+});
+
+
+
+
+
+
+ using System;
+using System.Diagnostics;
+using iot.Api;
+using iot.Client;
+using iot.Model;
+
+namespace Example
+{
+ public class propertiesV2UpdateExample
+ {
+ public void main()
+ {
+ // Configure OAuth2 access token for authorization: oauth2
+ Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
+
+ // Create an instance of the API class
+ var apiInstance = new PropertiesV2Api();
+ var id = id_example; // String | The id of the thing (default to null)
+ var pid = pid_example; // String | The id of the property (default to null)
+ var property = new Property(); // Property |
+ var xOrganization = xOrganization_example; // String | The id of the organization (optional) (default to null)
+
+ try {
+ // update properties_v2
+ ArduinoProperty result = apiInstance.propertiesV2Update(id, pid, property, xOrganization);
+ Debug.WriteLine(result);
+ } catch (Exception e) {
+ Debug.Print("Exception when calling PropertiesV2Api.propertiesV2Update: " + e.Message );
+ }
+ }
+ }
+}
+
+
+
+
+ <?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure OAuth2 access token for authorization: oauth2
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\PropertiesV2Api();
+$id = id_example; // String | The id of the thing
+$pid = pid_example; // String | The id of the property
+$property = ; // Property |
+$xOrganization = xOrganization_example; // String | The id of the organization
+
+try {
+ $result = $api_instance->propertiesV2Update($id, $pid, $property, $xOrganization);
+ print_r($result);
+} catch (Exception $e) {
+ echo 'Exception when calling PropertiesV2Api->propertiesV2Update: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+
+
+ use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::PropertiesV2Api;
+
+# Configure OAuth2 access token for authorization: oauth2
+$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::PropertiesV2Api->new();
+my $id = id_example; # String | The id of the thing
+my $pid = pid_example; # String | The id of the property
+my $property = WWW::OPenAPIClient::Object::Property->new(); # Property |
+my $xOrganization = xOrganization_example; # String | The id of the organization
+
+eval {
+ my $result = $api_instance->propertiesV2Update(id => $id, pid => $pid, property => $property, xOrganization => $xOrganization);
+ print Dumper($result);
+};
+if ($@) {
+ warn "Exception when calling PropertiesV2Api->propertiesV2Update: $@\n";
+}
+
+
+
+ from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: oauth2
+openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# Create an instance of the API class
+api_instance = openapi_client.PropertiesV2Api()
+id = id_example # String | The id of the thing (default to null)
+pid = pid_example # String | The id of the property (default to null)
+property = # Property |
+xOrganization = xOrganization_example # String | The id of the organization (optional) (default to null)
+
+try:
+ # update properties_v2
+ api_response = api_instance.properties_v2_update(id, pid, property, xOrganization=xOrganization)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling PropertiesV2Api->propertiesV2Update: %s\n" % e)
+
+
+
+ extern crate PropertiesV2Api;
+
+pub fn main() {
+ let id = id_example; // String
+ let pid = pid_example; // String
+ let property = ; // Property
+ let xOrganization = xOrganization_example; // String
+
+ let mut context = PropertiesV2Api::Context::default();
+ let result = client.propertiesV2Update(id, pid, property, xOrganization, &context).wait();
+
+ println!("{:?}", result);
+}
+
+
+
+
+ Scopes
+
+
+
+
+ Parameters
+
+ Path parameters
+
+
+ Name
+ Description
+
+ id*
+
+
+
+
+
+
+
+ String
+
+
+
+The id of the thing
+
+
+
+ Required
+
+
+
+
+pid*
+
+
+
+
+
+
+
+ String
+
+
+
+The id of the property
+
+
+
+ Required
+
+
+
+
+
+
+ Header parameters
+
+
+ Name
+ Description
+
+ X-Organization
+
+
+
+
+
+
+
+ String
+
+
+
+The id of the organization
+
+
+
+
+
+
+
+ Body parameters
+
+
+ Name
+ Description
+
+ property *
+
+PropertyPayload describes a property of a thing. No field is mandatory
+
+
+
+
+
+
+
+ Responses
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SeriesV2
+
+
+
+ seriesV2BatchQuery
+ batch_query series_v2
+
+
+
+
+ Returns the batch of time-series aggregated samples
+
+
+ /v2/series/batch_query
+
+
Usage and SDK Samples
+
+
+ - Curl
+
+
+
+
+
+ - JavaScript
+
+
+
+
+
+
+
+
+
+
+ curl -X POST \
+ \
+ -H "Accept: application/vnd.arduino.series.batch+json,application/vnd.goa.error+json" \
+ -H "Content-Type: application/json,application/x-www-form-urlencoded" \
+ "https://api2.arduino.cc/iot/v2/series/batch_query" \
+ -d '{
+ "resp_version" : 1,
+ "requests" : [ {
+ "q" : "q",
+ "series_limit" : 6,
+ "aggregation" : "AVG",
+ "from" : "2000-01-23T04:56:07.000+00:00",
+ "interval" : 0,
+ "to" : "2000-01-23T04:56:07.000+00:00"
+ }, {
+ "q" : "q",
+ "series_limit" : 6,
+ "aggregation" : "AVG",
+ "from" : "2000-01-23T04:56:07.000+00:00",
+ "interval" : 0,
+ "to" : "2000-01-23T04:56:07.000+00:00"
+ } ]
+}' \
+ -d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded'
+
+
+
+ import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.SeriesV2Api;
+
+import java.io.File;
+import java.util.*;
+
+public class SeriesV2ApiExample {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+
+ // Configure OAuth2 access token for authorization: oauth2
+ OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
+ oauth2.setAccessToken("YOUR ACCESS TOKEN");
+
+ // Create an instance of the API class
+ SeriesV2Api apiInstance = new SeriesV2Api();
+ BatchQueryRequestsMediaV1 batchQueryRequestsMediaV1 = ; // BatchQueryRequestsMediaV1 |
+
+ try {
+ ArduinoSeriesBatch result = apiInstance.seriesV2BatchQuery(batchQueryRequestsMediaV1);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling SeriesV2Api#seriesV2BatchQuery");
+ e.printStackTrace();
+ }
+ }
+}
+
+
+
+
+ import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final BatchQueryRequestsMediaV1 batchQueryRequestsMediaV1 = new BatchQueryRequestsMediaV1(); // BatchQueryRequestsMediaV1 |
+
+try {
+ final result = await api_instance.seriesV2BatchQuery(batchQueryRequestsMediaV1);
+ print(result);
+} catch (e) {
+ print('Exception when calling DefaultApi->seriesV2BatchQuery: $e\n');
+}
+
+
+
+
+
+ import org.openapitools.client.api.SeriesV2Api;
+
+public class SeriesV2ApiExample {
+ public static void main(String[] args) {
+ SeriesV2Api apiInstance = new SeriesV2Api();
+ BatchQueryRequestsMediaV1 batchQueryRequestsMediaV1 = ; // BatchQueryRequestsMediaV1 |
+
+ try {
+ ArduinoSeriesBatch result = apiInstance.seriesV2BatchQuery(batchQueryRequestsMediaV1);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling SeriesV2Api#seriesV2BatchQuery");
+ e.printStackTrace();
+ }
+ }
+}
+
+
+
+ Configuration *apiConfig = [Configuration sharedConfig];
+
+// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
+[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
+
+
+// Create an instance of the API class
+SeriesV2Api *apiInstance = [[SeriesV2Api alloc] init];
+BatchQueryRequestsMediaV1 *batchQueryRequestsMediaV1 = ; //
+
+// batch_query series_v2
+[apiInstance seriesV2BatchQueryWith:batchQueryRequestsMediaV1
+ completionHandler: ^(ArduinoSeriesBatch output, NSError* error) {
+ if (output) {
+ NSLog(@"%@", output);
+ }
+ if (error) {
+ NSLog(@"Error: %@", error);
+ }
+}];
+
+
+
+
+ var ArduinoIotClient = require('@arduino/arduino-iot-client');
+var defaultClient = ArduinoIotClient.ApiClient.instance;
+
+// Configure OAuth2 access token for authorization: oauth2
+var oauth2 = defaultClient.authentications['oauth2'];
+oauth2.accessToken = "YOUR ACCESS TOKEN";
+
+// Create an instance of the API class
+var api = new ArduinoIotClient.SeriesV2Api()
+var batchQueryRequestsMediaV1 = ; // {BatchQueryRequestsMediaV1}
+api.seriesV2BatchQuery(batchQueryRequestsMediaV1).then(function(data) {
+ console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+ console.error(error);
+});
+
+
+
+
+
+
+ using System;
+using System.Diagnostics;
+using iot.Api;
+using iot.Client;
+using iot.Model;
+
+namespace Example
+{
+ public class seriesV2BatchQueryExample
+ {
+ public void main()
+ {
+ // Configure OAuth2 access token for authorization: oauth2
+ Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
+
+ // Create an instance of the API class
+ var apiInstance = new SeriesV2Api();
+ var batchQueryRequestsMediaV1 = new BatchQueryRequestsMediaV1(); // BatchQueryRequestsMediaV1 |
+
+ try {
+ // batch_query series_v2
+ ArduinoSeriesBatch result = apiInstance.seriesV2BatchQuery(batchQueryRequestsMediaV1);
+ Debug.WriteLine(result);
+ } catch (Exception e) {
+ Debug.Print("Exception when calling SeriesV2Api.seriesV2BatchQuery: " + e.Message );
+ }
+ }
+ }
+}
+
+
+
+
+ <?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure OAuth2 access token for authorization: oauth2
+OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\SeriesV2Api();
+$batchQueryRequestsMediaV1 = ; // BatchQueryRequestsMediaV1 |
+
+try {
+ $result = $api_instance->seriesV2BatchQuery($batchQueryRequestsMediaV1);
+ print_r($result);
+} catch (Exception $e) {
+ echo 'Exception when calling SeriesV2Api->seriesV2BatchQuery: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+
+
+ use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::SeriesV2Api;
+
+# Configure OAuth2 access token for authorization: oauth2
+$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::SeriesV2Api->new();
+my $batchQueryRequestsMediaV1 = WWW::OPenAPIClient::Object::BatchQueryRequestsMediaV1->new(); # BatchQueryRequestsMediaV1 |
+
+eval {
+ my $result = $api_instance->seriesV2BatchQuery(batchQueryRequestsMediaV1 => $batchQueryRequestsMediaV1);
+ print Dumper($result);
+};
+if ($@) {
+ warn "Exception when calling SeriesV2Api->seriesV2BatchQuery: $@\n";
+}
+
+
+
+ from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: oauth2
+openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# Create an instance of the API class
+api_instance = openapi_client.SeriesV2Api()
+batchQueryRequestsMediaV1 = # BatchQueryRequestsMediaV1 |
+
+try:
+ # batch_query series_v2
+ api_response = api_instance.series_v2_batch_query(batchQueryRequestsMediaV1)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling SeriesV2Api->seriesV2BatchQuery: %s\n" % e)
+
+
+
+ extern crate SeriesV2Api;
+
+pub fn main() {
+ let batchQueryRequestsMediaV1 = ; // BatchQueryRequestsMediaV1
+
+ let mut context = SeriesV2Api::Context::default();
+ let result = client.seriesV2BatchQuery(batchQueryRequestsMediaV1, &context).wait();
+
+ println!("{:?}", result);
+}
+
+
+
+
+ Scopes
+
+
+
+
+ Parameters
+
+
+
+ Body parameters
+
+
+ Name
+ Description
+
+ batchQueryRequestsMediaV1 *
+
+
+
+
+
+
+
+
+
+ Responses
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+ Schema
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
+
+
- propertiesV2Update
- update properties_v2
+ seriesV2BatchQueryRaw
+ batch_query_raw series_v2
- Updates a property associated to a thing
+ Returns the batch of time-series raw samples
- /v2/things/{id}/properties/{pid}
+ /v2/series/batch_query_raw
Usage and SDK Samples
- - Curl
-
-
-
-
-
- - JavaScript
-
-
-
-
-
-
+ - Curl
+
+
+
+
+
+ - JavaScript
+
+
+
+
+
+
-
+
curl -X POST \
\
- -H "Accept: application/vnd.arduino.property+json,application/vnd.goa.error+json" \
+ -H "Accept: application/vnd.arduino.series.raw.batch+json,application/vnd.goa.error+json" \
-H "Content-Type: application/json,application/x-www-form-urlencoded" \
- "https://api2.arduino.cc/iot/v2/things/{id}/properties/{pid}" \
+ "https://api2.arduino.cc/iot/v2/series/batch_query_raw" \
+ -d '{
+ "resp_version" : 6,
+ "requests" : [ {
+ "q" : "q",
+ "series_limit" : 0,
+ "from" : "2000-01-23T04:56:07.000+00:00",
+ "sort" : "DESC",
+ "to" : "2000-01-23T04:56:07.000+00:00"
+ }, {
+ "q" : "q",
+ "series_limit" : 0,
+ "from" : "2000-01-23T04:56:07.000+00:00",
+ "sort" : "DESC",
+ "to" : "2000-01-23T04:56:07.000+00:00"
+ } ]
+}' \
-d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded'
-
+
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
-import org.openapitools.client.api.PropertiesV2Api;
+import org.openapitools.client.api.SeriesV2Api;
import java.io.File;
import java.util.*;
-public class PropertiesV2ApiExample {
+public class SeriesV2ApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
@@ -30318,17 +33743,14 @@ Usage and SDK Samples
oauth2.setAccessToken("YOUR ACCESS TOKEN");
// Create an instance of the API class
- PropertiesV2Api apiInstance = new PropertiesV2Api();
- String id = id_example; // String | The id of the thing
- String pid = pid_example; // String | The id of the property
- Property property = ; // Property |
- String xOrganization = xOrganization_example; // String | The id of the organization
+ SeriesV2Api apiInstance = new SeriesV2Api();
+ BatchQueryRawRequestsMediaV1 batchQueryRawRequestsMediaV1 = ; // BatchQueryRawRequestsMediaV1 |
try {
- ArduinoProperty result = apiInstance.propertiesV2Update(id, pid, property, xOrganization);
+ ArduinoSeriesRawBatch result = apiInstance.seriesV2BatchQueryRaw(batchQueryRawRequestsMediaV1);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling PropertiesV2Api#propertiesV2Update");
+ System.err.println("Exception when calling SeriesV2Api#seriesV2BatchQueryRaw");
e.printStackTrace();
}
}
@@ -30336,52 +33758,46 @@ Usage and SDK Samples
-
+
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
-final String id = new String(); // String | The id of the thing
-final String pid = new String(); // String | The id of the property
-final Property property = new Property(); // Property |
-final String xOrganization = new String(); // String | The id of the organization
+final BatchQueryRawRequestsMediaV1 batchQueryRawRequestsMediaV1 = new BatchQueryRawRequestsMediaV1(); // BatchQueryRawRequestsMediaV1 |
try {
- final result = await api_instance.propertiesV2Update(id, pid, property, xOrganization);
+ final result = await api_instance.seriesV2BatchQueryRaw(batchQueryRawRequestsMediaV1);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->propertiesV2Update: $e\n');
+ print('Exception when calling DefaultApi->seriesV2BatchQueryRaw: $e\n');
}
-
- import org.openapitools.client.api.PropertiesV2Api;
+
+ import org.openapitools.client.api.SeriesV2Api;
-public class PropertiesV2ApiExample {
+public class SeriesV2ApiExample {
public static void main(String[] args) {
- PropertiesV2Api apiInstance = new PropertiesV2Api();
- String id = id_example; // String | The id of the thing
- String pid = pid_example; // String | The id of the property
- Property property = ; // Property |
- String xOrganization = xOrganization_example; // String | The id of the organization
+ SeriesV2Api apiInstance = new SeriesV2Api();
+ BatchQueryRawRequestsMediaV1 batchQueryRawRequestsMediaV1 = ; // BatchQueryRawRequestsMediaV1 |
try {
- ArduinoProperty result = apiInstance.propertiesV2Update(id, pid, property, xOrganization);
+ ArduinoSeriesRawBatch result = apiInstance.seriesV2BatchQueryRaw(batchQueryRawRequestsMediaV1);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling PropertiesV2Api#propertiesV2Update");
+ System.err.println("Exception when calling SeriesV2Api#seriesV2BatchQueryRaw");
e.printStackTrace();
}
}
}
-
+
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
@@ -30389,18 +33805,12 @@ Usage and SDK Samples
// Create an instance of the API class
-PropertiesV2Api *apiInstance = [[PropertiesV2Api alloc] init];
-String *id = id_example; // The id of the thing (default to null)
-String *pid = pid_example; // The id of the property (default to null)
-Property *property = ; //
-String *xOrganization = xOrganization_example; // The id of the organization (optional) (default to null)
+SeriesV2Api *apiInstance = [[SeriesV2Api alloc] init];
+BatchQueryRawRequestsMediaV1 *batchQueryRawRequestsMediaV1 = ; //
-// update properties_v2
-[apiInstance propertiesV2UpdateWith:id
- pid:pid
- property:property
- xOrganization:xOrganization
- completionHandler: ^(ArduinoProperty output, NSError* error) {
+// batch_query_raw series_v2
+[apiInstance seriesV2BatchQueryRawWith:batchQueryRawRequestsMediaV1
+ completionHandler: ^(ArduinoSeriesRawBatch output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
@@ -30411,7 +33821,7 @@ Usage and SDK Samples
-
+
var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;
@@ -30420,14 +33830,9 @@ Usage and SDK Samples
oauth2.accessToken = "YOUR ACCESS TOKEN";
// Create an instance of the API class
-var api = new ArduinoIotClient.PropertiesV2Api()
-var id = id_example; // {String} The id of the thing
-var pid = pid_example; // {String} The id of the property
-var property = ; // {Property}
-var opts = {
- 'xOrganization': xOrganization_example // {String} The id of the organization
-};
-api.propertiesV2Update(id, pid, property, opts).then(function(data) {
+var api = new ArduinoIotClient.SeriesV2Api()
+var batchQueryRawRequestsMediaV1 = ; // {BatchQueryRawRequestsMediaV1}
+api.seriesV2BatchQueryRaw(batchQueryRawRequestsMediaV1).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
@@ -30436,10 +33841,10 @@ Usage and SDK Samples
-
-
+
using System;
using System.Diagnostics;
using iot.Api;
@@ -30448,7 +33853,7 @@ Usage and SDK Samples
namespace Example
{
- public class propertiesV2UpdateExample
+ public class seriesV2BatchQueryRawExample
{
public void main()
{
@@ -30456,18 +33861,15 @@ Usage and SDK Samples
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
// Create an instance of the API class
- var apiInstance = new PropertiesV2Api();
- var id = id_example; // String | The id of the thing (default to null)
- var pid = pid_example; // String | The id of the property (default to null)
- var property = new Property(); // Property |
- var xOrganization = xOrganization_example; // String | The id of the organization (optional) (default to null)
+ var apiInstance = new SeriesV2Api();
+ var batchQueryRawRequestsMediaV1 = new BatchQueryRawRequestsMediaV1(); // BatchQueryRawRequestsMediaV1 |
try {
- // update properties_v2
- ArduinoProperty result = apiInstance.propertiesV2Update(id, pid, property, xOrganization);
+ // batch_query_raw series_v2
+ ArduinoSeriesRawBatch result = apiInstance.seriesV2BatchQueryRaw(batchQueryRawRequestsMediaV1);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling PropertiesV2Api.propertiesV2Update: " + e.Message );
+ Debug.Print("Exception when calling SeriesV2Api.seriesV2BatchQueryRaw: " + e.Message );
}
}
}
@@ -30475,7 +33877,7 @@ Usage and SDK Samples
-
+
<?php
require_once(__DIR__ . '/vendor/autoload.php');
@@ -30483,46 +33885,40 @@ Usage and SDK Samples
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\PropertiesV2Api();
-$id = id_example; // String | The id of the thing
-$pid = pid_example; // String | The id of the property
-$property = ; // Property |
-$xOrganization = xOrganization_example; // String | The id of the organization
+$api_instance = new OpenAPITools\Client\Api\SeriesV2Api();
+$batchQueryRawRequestsMediaV1 = ; // BatchQueryRawRequestsMediaV1 |
try {
- $result = $api_instance->propertiesV2Update($id, $pid, $property, $xOrganization);
+ $result = $api_instance->seriesV2BatchQueryRaw($batchQueryRawRequestsMediaV1);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling PropertiesV2Api->propertiesV2Update: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling SeriesV2Api->seriesV2BatchQueryRaw: ', $e->getMessage(), PHP_EOL;
}
?>
-
+
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::PropertiesV2Api;
+use WWW::OPenAPIClient::SeriesV2Api;
# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::PropertiesV2Api->new();
-my $id = id_example; # String | The id of the thing
-my $pid = pid_example; # String | The id of the property
-my $property = WWW::OPenAPIClient::Object::Property->new(); # Property |
-my $xOrganization = xOrganization_example; # String | The id of the organization
+my $api_instance = WWW::OPenAPIClient::SeriesV2Api->new();
+my $batchQueryRawRequestsMediaV1 = WWW::OPenAPIClient::Object::BatchQueryRawRequestsMediaV1->new(); # BatchQueryRawRequestsMediaV1 |
eval {
- my $result = $api_instance->propertiesV2Update(id => $id, pid => $pid, property => $property, xOrganization => $xOrganization);
+ my $result = $api_instance->seriesV2BatchQueryRaw(batchQueryRawRequestsMediaV1 => $batchQueryRawRequestsMediaV1);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling PropertiesV2Api->propertiesV2Update: $@\n";
+ warn "Exception when calling SeriesV2Api->seriesV2BatchQueryRaw: $@\n";
}
-
+
from __future__ import print_statement
import time
import openapi_client
@@ -30533,31 +33929,25 @@ Usage and SDK Samples
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Create an instance of the API class
-api_instance = openapi_client.PropertiesV2Api()
-id = id_example # String | The id of the thing (default to null)
-pid = pid_example # String | The id of the property (default to null)
-property = # Property |
-xOrganization = xOrganization_example # String | The id of the organization (optional) (default to null)
+api_instance = openapi_client.SeriesV2Api()
+batchQueryRawRequestsMediaV1 = # BatchQueryRawRequestsMediaV1 |
try:
- # update properties_v2
- api_response = api_instance.properties_v2_update(id, pid, property, xOrganization=xOrganization)
+ # batch_query_raw series_v2
+ api_response = api_instance.series_v2_batch_query_raw(batchQueryRawRequestsMediaV1)
pprint(api_response)
except ApiException as e:
- print("Exception when calling PropertiesV2Api->propertiesV2Update: %s\n" % e)
+ print("Exception when calling SeriesV2Api->seriesV2BatchQueryRaw: %s\n" % e)
-
- extern crate PropertiesV2Api;
+
+ extern crate SeriesV2Api;
pub fn main() {
- let id = id_example; // String
- let pid = pid_example; // String
- let property = ; // Property
- let xOrganization = xOrganization_example; // String
+ let batchQueryRawRequestsMediaV1 = ; // BatchQueryRawRequestsMediaV1
- let mut context = PropertiesV2Api::Context::default();
- let result = client.propertiesV2Update(id, pid, property, xOrganization, &context).wait();
+ let mut context = SeriesV2Api::Context::default();
+ let result = client.seriesV2BatchQueryRaw(batchQueryRawRequestsMediaV1, &context).wait();
println!("{:?}", result);
}
@@ -30572,87 +33962,7 @@ Scopes
Parameters
- Path parameters
-
-
- Name
- Description
-
- id*
-
-
-
-
-
-
-
- String
-
-
-
-The id of the thing
-
-
-
- Required
-
-
-
-
-pid*
-
-
-
-
-
-
-
- String
-
-
-
-The id of the property
-
-
-
- Required
-
-
-
-
-
-
- Header parameters
-
-
- Name
- Description
-
- X-Organization
-
-
-
-
-
-
-
- String
-
-
-
-The id of the organization
-
-
-
-
-
-
Body parameters
@@ -30660,22 +33970,21 @@ Parameters
Name
Description
- property *
+ batchQueryRawRequestsMediaV1 *
-PropertyPayload describes a property of a thing. No field is mandatory
+
-
+
Parameters
Responses
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
- -
- Schema
-
+
+
-
+
+
+
+
+
-
-
-
-
-
-
-
+
+
+
+
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
- SeriesV2
-
-
+
+
- seriesV2BatchQuery
- batch_query series_v2
+ seriesV2BatchQueryRawLastValue
+ batch_query_raw_last_value series_v2
- Returns the batch of time-series aggregated samples
+ Returns the batch of time-series data raw
- /v2/series/batch_query
+ /v2/series/batch_query_raw/lastvalue
Usage and SDK Samples
- - Curl
-
-
-
-
-
- - JavaScript
-
-
-
-
-
-
+ - Curl
+
+
+
+
+
+ - JavaScript
+
+
+
+
+
+
-
+
curl -X POST \
\
- -H "Accept: application/vnd.arduino.series.batch+json,application/vnd.goa.error+json" \
+ -H "Accept: application/vnd.arduino.series.raw.batch.lastvalue+json,application/vnd.goa.error+json" \
-H "Content-Type: application/json,application/x-www-form-urlencoded" \
- "https://api2.arduino.cc/iot/v2/series/batch_query" \
+ "https://api2.arduino.cc/iot/v2/series/batch_query_raw/lastvalue" \
-d '{
- "resp_version" : 1,
"requests" : [ {
- "q" : "q",
- "series_limit" : 6,
- "aggregation" : "AVG",
- "from" : "2000-01-23T04:56:07.000+00:00",
- "interval" : 0,
- "to" : "2000-01-23T04:56:07.000+00:00"
+ "thing_id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+ "property_id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
- "q" : "q",
- "series_limit" : 6,
- "aggregation" : "AVG",
- "from" : "2000-01-23T04:56:07.000+00:00",
- "interval" : 0,
- "to" : "2000-01-23T04:56:07.000+00:00"
+ "thing_id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
+ "property_id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ]
}' \
-d 'Custom MIME type example not yet supported: application/x-www-form-urlencoded'
-
+
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
@@ -31106,13 +34385,13 @@ Usage and SDK Samples
// Create an instance of the API class
SeriesV2Api apiInstance = new SeriesV2Api();
- BatchQueryRequestsMediaV1 batchQueryRequestsMediaV1 = ; // BatchQueryRequestsMediaV1 |
+ BatchLastValueRequestsMediaV1 batchLastValueRequestsMediaV1 = ; // BatchLastValueRequestsMediaV1 |
try {
- ArduinoSeriesBatch result = apiInstance.seriesV2BatchQuery(batchQueryRequestsMediaV1);
+ ArduinoSeriesRawBatchLastvalue result = apiInstance.seriesV2BatchQueryRawLastValue(batchLastValueRequestsMediaV1);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling SeriesV2Api#seriesV2BatchQuery");
+ System.err.println("Exception when calling SeriesV2Api#seriesV2BatchQueryRawLastValue");
e.printStackTrace();
}
}
@@ -31120,46 +34399,46 @@ Usage and SDK Samples
-
+
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
-final BatchQueryRequestsMediaV1 batchQueryRequestsMediaV1 = new BatchQueryRequestsMediaV1(); // BatchQueryRequestsMediaV1 |
+final BatchLastValueRequestsMediaV1 batchLastValueRequestsMediaV1 = new BatchLastValueRequestsMediaV1(); // BatchLastValueRequestsMediaV1 |
try {
- final result = await api_instance.seriesV2BatchQuery(batchQueryRequestsMediaV1);
+ final result = await api_instance.seriesV2BatchQueryRawLastValue(batchLastValueRequestsMediaV1);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->seriesV2BatchQuery: $e\n');
+ print('Exception when calling DefaultApi->seriesV2BatchQueryRawLastValue: $e\n');
}
-
+
import org.openapitools.client.api.SeriesV2Api;
public class SeriesV2ApiExample {
public static void main(String[] args) {
SeriesV2Api apiInstance = new SeriesV2Api();
- BatchQueryRequestsMediaV1 batchQueryRequestsMediaV1 = ; // BatchQueryRequestsMediaV1 |
+ BatchLastValueRequestsMediaV1 batchLastValueRequestsMediaV1 = ; // BatchLastValueRequestsMediaV1 |
try {
- ArduinoSeriesBatch result = apiInstance.seriesV2BatchQuery(batchQueryRequestsMediaV1);
+ ArduinoSeriesRawBatchLastvalue result = apiInstance.seriesV2BatchQueryRawLastValue(batchLastValueRequestsMediaV1);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling SeriesV2Api#seriesV2BatchQuery");
+ System.err.println("Exception when calling SeriesV2Api#seriesV2BatchQueryRawLastValue");
e.printStackTrace();
}
}
}
-
+
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
@@ -31168,11 +34447,11 @@ Usage and SDK Samples
// Create an instance of the API class
SeriesV2Api *apiInstance = [[SeriesV2Api alloc] init];
-BatchQueryRequestsMediaV1 *batchQueryRequestsMediaV1 = ; //
+BatchLastValueRequestsMediaV1 *batchLastValueRequestsMediaV1 = ; //
-// batch_query series_v2
-[apiInstance seriesV2BatchQueryWith:batchQueryRequestsMediaV1
- completionHandler: ^(ArduinoSeriesBatch output, NSError* error) {
+// batch_query_raw_last_value series_v2
+[apiInstance seriesV2BatchQueryRawLastValueWith:batchLastValueRequestsMediaV1
+ completionHandler: ^(ArduinoSeriesRawBatchLastvalue output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
@@ -31183,7 +34462,7 @@ Usage and SDK Samples
-
+
var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;
@@ -31193,8 +34472,8 @@ Usage and SDK Samples
// Create an instance of the API class
var api = new ArduinoIotClient.SeriesV2Api()
-var batchQueryRequestsMediaV1 = ; // {BatchQueryRequestsMediaV1}
-api.seriesV2BatchQuery(batchQueryRequestsMediaV1).then(function(data) {
+var batchLastValueRequestsMediaV1 = ; // {BatchLastValueRequestsMediaV1}
+api.seriesV2BatchQueryRawLastValue(batchLastValueRequestsMediaV1).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
@@ -31203,10 +34482,10 @@ Usage and SDK Samples
-
-
+
using System;
using System.Diagnostics;
using iot.Api;
@@ -31215,7 +34494,7 @@ Usage and SDK Samples
namespace Example
{
- public class seriesV2BatchQueryExample
+ public class seriesV2BatchQueryRawLastValueExample
{
public void main()
{
@@ -31224,14 +34503,14 @@ Usage and SDK Samples
// Create an instance of the API class
var apiInstance = new SeriesV2Api();
- var batchQueryRequestsMediaV1 = new BatchQueryRequestsMediaV1(); // BatchQueryRequestsMediaV1 |
+ var batchLastValueRequestsMediaV1 = new BatchLastValueRequestsMediaV1(); // BatchLastValueRequestsMediaV1 |
try {
- // batch_query series_v2
- ArduinoSeriesBatch result = apiInstance.seriesV2BatchQuery(batchQueryRequestsMediaV1);
+ // batch_query_raw_last_value series_v2
+ ArduinoSeriesRawBatchLastvalue result = apiInstance.seriesV2BatchQueryRawLastValue(batchLastValueRequestsMediaV1);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling SeriesV2Api.seriesV2BatchQuery: " + e.Message );
+ Debug.Print("Exception when calling SeriesV2Api.seriesV2BatchQueryRawLastValue: " + e.Message );
}
}
}
@@ -31239,7 +34518,7 @@ Usage and SDK Samples
-
+
<?php
require_once(__DIR__ . '/vendor/autoload.php');
@@ -31248,18 +34527,18 @@ Usage and SDK Samples
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SeriesV2Api();
-$batchQueryRequestsMediaV1 = ; // BatchQueryRequestsMediaV1 |
+$batchLastValueRequestsMediaV1 = ; // BatchLastValueRequestsMediaV1 |
try {
- $result = $api_instance->seriesV2BatchQuery($batchQueryRequestsMediaV1);
+ $result = $api_instance->seriesV2BatchQueryRawLastValue($batchLastValueRequestsMediaV1);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling SeriesV2Api->seriesV2BatchQuery: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling SeriesV2Api->seriesV2BatchQueryRawLastValue: ', $e->getMessage(), PHP_EOL;
}
?>
-
+
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SeriesV2Api;
@@ -31269,18 +34548,18 @@ Usage and SDK Samples
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SeriesV2Api->new();
-my $batchQueryRequestsMediaV1 = WWW::OPenAPIClient::Object::BatchQueryRequestsMediaV1->new(); # BatchQueryRequestsMediaV1 |
+my $batchLastValueRequestsMediaV1 = WWW::OPenAPIClient::Object::BatchLastValueRequestsMediaV1->new(); # BatchLastValueRequestsMediaV1 |
eval {
- my $result = $api_instance->seriesV2BatchQuery(batchQueryRequestsMediaV1 => $batchQueryRequestsMediaV1);
+ my $result = $api_instance->seriesV2BatchQueryRawLastValue(batchLastValueRequestsMediaV1 => $batchLastValueRequestsMediaV1);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling SeriesV2Api->seriesV2BatchQuery: $@\n";
+ warn "Exception when calling SeriesV2Api->seriesV2BatchQueryRawLastValue: $@\n";
}
-
+
from __future__ import print_statement
import time
import openapi_client
@@ -31292,24 +34571,24 @@ Usage and SDK Samples
# Create an instance of the API class
api_instance = openapi_client.SeriesV2Api()
-batchQueryRequestsMediaV1 = # BatchQueryRequestsMediaV1 |
+batchLastValueRequestsMediaV1 = # BatchLastValueRequestsMediaV1 |
try:
- # batch_query series_v2
- api_response = api_instance.series_v2_batch_query(batchQueryRequestsMediaV1)
+ # batch_query_raw_last_value series_v2
+ api_response = api_instance.series_v2_batch_query_raw_last_value(batchLastValueRequestsMediaV1)
pprint(api_response)
except ApiException as e:
- print("Exception when calling SeriesV2Api->seriesV2BatchQuery: %s\n" % e)
+ print("Exception when calling SeriesV2Api->seriesV2BatchQueryRawLastValue: %s\n" % e)
-
+
extern crate SeriesV2Api;
pub fn main() {
- let batchQueryRequestsMediaV1 = ; // BatchQueryRequestsMediaV1
+ let batchLastValueRequestsMediaV1 = ; // BatchLastValueRequestsMediaV1
let mut context = SeriesV2Api::Context::default();
- let result = client.seriesV2BatchQuery(batchQueryRequestsMediaV1, &context).wait();
+ let result = client.seriesV2BatchQueryRawLastValue(batchLastValueRequestsMediaV1, &context).wait();
println!("{:?}", result);
}
@@ -31332,7 +34611,7 @@ Parameters
Name
Description
- batchQueryRequestsMediaV1 *
+ batchLastValueRequestsMediaV1 *
-
+
Parameters
Responses
-
-
+
+
-
-
-
- -
- Schema
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
+
-
-
+
+
-
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
- seriesV2BatchQueryRaw
- batch_query_raw series_v2
+ seriesV2BatchQuerySampling
+ batch_query_sampling series_v2
- Returns the batch of time-series raw samples
+ Returns a batch of time-series sampled samples. To be used for types that does not support mathematic aggregation. Types supported: strings, complex types.
-