Skip to content

Latest commit

 

History

History
executable file
·
372 lines (260 loc) · 12.5 KB

ACDeviceTypesApi.md

File metadata and controls

executable file
·
372 lines (260 loc) · 12.5 KB
Raw

ACDeviceTypesApi

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

Method HTTP request Description
getAvailableManifestVersions GET /devicetypes/{deviceTypeId}/availablemanifestversions Get Available Manifest Versions
getDeviceType GET /devicetypes/{deviceTypeId} Get Device Type
getDeviceTypes GET /devicetypes Get Device Types
getDeviceTypesByApplication GET /applications/{appId}/devicetypes Get Device Types by Application
getLatestManifestProperties GET /devicetypes/{deviceTypeId}/manifests/latest/properties Get Latest Manifest Properties
getManifestProperties GET /devicetypes/{deviceTypeId}/manifests/{version}/properties Get manifest properties

getAvailableManifestVersions

-(NSNumber*) getAvailableManifestVersionsWithDeviceTypeId: (NSString*) deviceTypeId
        completionHandler: (void (^)(ACManifestVersionsEnvelope* output, NSError* error)) handler;

Get Available Manifest Versions

Get a Device Type's available manifest versions

Example

ACConfiguration *apiConfig = [ACConfiguration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: artikcloud_oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


NSString* deviceTypeId = @"deviceTypeId_example"; // deviceTypeId

ACDeviceTypesApi*apiInstance = [[ACDeviceTypesApi alloc] init];

// Get Available Manifest Versions
[apiInstance getAvailableManifestVersionsWithDeviceTypeId:deviceTypeId
          completionHandler: ^(ACManifestVersionsEnvelope* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ACDeviceTypesApi->getAvailableManifestVersions: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
deviceTypeId NSString* deviceTypeId

Return type

ACManifestVersionsEnvelope*

Authorization

artikcloud_oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDeviceType

-(NSNumber*) getDeviceTypeWithDeviceTypeId: (NSString*) deviceTypeId
        completionHandler: (void (^)(ACDeviceTypeEnvelope* output, NSError* error)) handler;

Get Device Type

Retrieves a Device Type

Example

ACConfiguration *apiConfig = [ACConfiguration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: artikcloud_oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


NSString* deviceTypeId = @"deviceTypeId_example"; // deviceTypeId

ACDeviceTypesApi*apiInstance = [[ACDeviceTypesApi alloc] init];

// Get Device Type
[apiInstance getDeviceTypeWithDeviceTypeId:deviceTypeId
          completionHandler: ^(ACDeviceTypeEnvelope* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ACDeviceTypesApi->getDeviceType: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
deviceTypeId NSString* deviceTypeId

Return type

ACDeviceTypeEnvelope*

Authorization

artikcloud_oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDeviceTypes

-(NSNumber*) getDeviceTypesWithName: (NSString*) name
    offset: (NSNumber*) offset
    count: (NSNumber*) count
    tags: (NSString*) tags
        completionHandler: (void (^)(ACDeviceTypesEnvelope* output, NSError* error)) handler;

Get Device Types

Retrieves Device Types

Example

ACConfiguration *apiConfig = [ACConfiguration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: artikcloud_oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


NSString* name = @"name_example"; // Device Type name
NSNumber* offset = @56; // Offset for pagination. (optional)
NSNumber* count = @56; // Desired count of items in the result set (optional)
NSString* tags = @"tags_example"; // Elements tagged with the list of tags. (comma separated) (optional)

ACDeviceTypesApi*apiInstance = [[ACDeviceTypesApi alloc] init];

// Get Device Types
[apiInstance getDeviceTypesWithName:name
              offset:offset
              count:count
              tags:tags
          completionHandler: ^(ACDeviceTypesEnvelope* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ACDeviceTypesApi->getDeviceTypes: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
name NSString* Device Type name
offset NSNumber* Offset for pagination. [optional]
count NSNumber* Desired count of items in the result set [optional]
tags NSString* Elements tagged with the list of tags. (comma separated) [optional]

Return type

ACDeviceTypesEnvelope*

Authorization

artikcloud_oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDeviceTypesByApplication

-(NSNumber*) getDeviceTypesByApplicationWithAppId: (NSString*) appId
    productInfo: (NSNumber*) productInfo
    count: (NSNumber*) count
    offset: (NSNumber*) offset
        completionHandler: (void (^)(ACDeviceTypesEnvelope* output, NSError* error)) handler;

Get Device Types by Application

Get Device Types by Application

Example

ACConfiguration *apiConfig = [ACConfiguration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: artikcloud_oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


NSString* appId = @"appId_example"; // Application ID.
NSNumber* productInfo = @true; // Flag to include the associated ProductInfo if present (optional)
NSNumber* count = @56; // Desired count of items in the result set. (optional)
NSNumber* offset = @56; // Offset for pagination. (optional)

ACDeviceTypesApi*apiInstance = [[ACDeviceTypesApi alloc] init];

// Get Device Types by Application
[apiInstance getDeviceTypesByApplicationWithAppId:appId
              productInfo:productInfo
              count:count
              offset:offset
          completionHandler: ^(ACDeviceTypesEnvelope* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ACDeviceTypesApi->getDeviceTypesByApplication: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
appId NSString* Application ID.
productInfo NSNumber* Flag to include the associated ProductInfo if present [optional]
count NSNumber* Desired count of items in the result set. [optional]
offset NSNumber* Offset for pagination. [optional]

Return type

ACDeviceTypesEnvelope*

Authorization

artikcloud_oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLatestManifestProperties

-(NSNumber*) getLatestManifestPropertiesWithDeviceTypeId: (NSString*) deviceTypeId
        completionHandler: (void (^)(ACManifestPropertiesEnvelope* output, NSError* error)) handler;

Get Latest Manifest Properties

Get a Device Type's manifest properties for the latest version.

Example

ACConfiguration *apiConfig = [ACConfiguration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: artikcloud_oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


NSString* deviceTypeId = @"deviceTypeId_example"; // Device Type ID.

ACDeviceTypesApi*apiInstance = [[ACDeviceTypesApi alloc] init];

// Get Latest Manifest Properties
[apiInstance getLatestManifestPropertiesWithDeviceTypeId:deviceTypeId
          completionHandler: ^(ACManifestPropertiesEnvelope* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ACDeviceTypesApi->getLatestManifestProperties: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
deviceTypeId NSString* Device Type ID.

Return type

ACManifestPropertiesEnvelope*

Authorization

artikcloud_oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getManifestProperties

-(NSNumber*) getManifestPropertiesWithDeviceTypeId: (NSString*) deviceTypeId
    version: (NSString*) version
        completionHandler: (void (^)(ACManifestPropertiesEnvelope* output, NSError* error)) handler;

Get manifest properties

Get a Device Type's manifest properties for a specific version.

Example

ACConfiguration *apiConfig = [ACConfiguration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: artikcloud_oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


NSString* deviceTypeId = @"deviceTypeId_example"; // Device Type ID.
NSString* version = @"version_example"; // Manifest Version.

ACDeviceTypesApi*apiInstance = [[ACDeviceTypesApi alloc] init];

// Get manifest properties
[apiInstance getManifestPropertiesWithDeviceTypeId:deviceTypeId
              version:version
          completionHandler: ^(ACManifestPropertiesEnvelope* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ACDeviceTypesApi->getManifestProperties: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
deviceTypeId NSString* Device Type ID.
version NSString* Manifest Version.

Return type

ACManifestPropertiesEnvelope*

Authorization

artikcloud_oauth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]