iotmgr

package module
v0.0.0-...-46b568b Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 24, 2020 License: Apache-2.0 Imports: 23 Imported by: 0

README

Go API client for iotmgr

The Bosch IoT Manager REST API provides the full functionality of the service, including:

· Retrieving devices and features; adding and modifying device-specific properties and attributes

· A simple device registration mechanism

· All grouping capabilities - listing, creating, modifying and deleting directories and tags

· The complete mass management experience, which allows full control over tasks and rules

Find out more details in our documentation.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./iotmgr"

Documentation for API Endpoints

All URIs are relative to https://manager.eu-1.bosch-iot-suite.com/api/1

Class Method HTTP request Description
DevicesApi Attribute Get /di/devices/{deviceId}/attributes/{attributePath} Retrieve a specific Attribute of a specific device
DevicesApi CreateAttributes Post /di/devices/{deviceId}/attributes Add Attributes of a specific Device
DevicesApi Definition Get /di/devices/{deviceId}/features/{featureId}/definitions/{fullyQualifiedIdentifier} Retrieve the Definition of a Feature
DevicesApi Definitions Get /di/devices/{deviceId}/features/{featureId}/definitions List all Definitions of a Feature
DevicesApi DeleteAttribute Delete /di/devices/{deviceId}/attributes/{attributePath} Delete Attribute of a specific Device
DevicesApi DeleteAttributes Delete /di/devices/{deviceId}/attributes Delete Attributes of a specific Device
DevicesApi Device Get /di/devices/{deviceId} Retrieve an existing Device identified by the given deviceId
DevicesApi Devices Get /di/gateways/{gatewayId}/devices Retrieve a list of Edge Devices attached to the gateway
DevicesApi Devices1 Get /di/devices Retrieve all Devices
DevicesApi DevicesCount Get /di/devices/count Retrieve the number of Devices matching the given filter
DevicesApi DevicesCount1 Get /di/gateways/{gatewayId}/devices/count Retrieve the number of Devices matching the given filter
DevicesApi Feature Get /di/devices/{deviceId}/features/{featureId} Retrieve a Feature of a Device
DevicesApi FeatureProperties Get /di/devices/{deviceId}/features/{featureId}/properties List the Properties of a Feature
DevicesApi Features Get /di/devices/{deviceId}/features List all Features of a specific device
DevicesApi Gateway Get /di/gateways/{gatewayId} Retrieve an existing Gateway identified by the given gatewayId
DevicesApi Gateways Get /di/gateways Retrieve all Gateways
DevicesApi GatewaysCount Get /di/gateways/count Retrieve the number of gateways matching the given filter
DevicesApi ListAttributes Get /di/devices/{deviceId}/attributes List all Attributes of a specific Device
DevicesApi Property Get /di/devices/{deviceId}/features/{featureId}/properties/{propertyName} Retrieve the Property of a Feature
DevicesApi Register Post /di/devices/{deviceId} Register a specific Device
DevicesApi SetAttribute Put /di/devices/{deviceId}/attributes Add Attribute of a specific Device
DevicesApi Unregister Delete /di/devices/{deviceId} Unregister a specific Device
GroupsApi Attribute1 Get /di/groups/directories/{path}/attributes/{attributePath} Retrieve a specific Attribute of a specific device
GroupsApi CreateAttributes1 Post /di/groups/directories/{path}/attributes Add Attributes of a specific Directory
GroupsApi CreateDirectory Post /di/groups/directories Add a Directory to the directory hierarchy
GroupsApi CreateTag Post /di/groups/tags Create a Tag
GroupsApi CreateTagAttributes Post /di/groups/tags/{name}/attributes Add Attributes of a specific Tag
GroupsApi DeleteAttribute1 Delete /di/groups/directories/{path}/attributes/{attributePath} Delete Attribute of a specific Directory
GroupsApi DeleteAttributes1 Delete /di/groups/directories/{path}/attributes Delete Attributes of a specific Directory
GroupsApi DeleteDirectory Delete /di/groups/directories/{path} Delete an existing directory from the directory hierarchy
GroupsApi DeleteTag Delete /di/groups/tags/{name} Delete a Tag
GroupsApi DeleteTagAttribute Delete /di/groups/tags/{name}/attributes/{attributePath} Add Attribute of a specific Tag
GroupsApi DeleteTagAttributes Delete /di/groups/tags/{name}/attributes Add Attributes of a specific Tag
GroupsApi Directories Get /di/groups/directories List all Directories
GroupsApi Directory Get /di/groups/directories/{path} Retrieve an existing Directory from the groups hierarchy
GroupsApi DirectoryMembers Get /di/groups/directories/{path}/members Retrieve a list of Members
GroupsApi ListAttributes1 Get /di/groups/directories/{path}/attributes List all Attributes of a specific Directory
GroupsApi ListTagAttributes Get /di/groups/tags/{name}/attributes List all Attributes of a specific Tag
GroupsApi MembersTag Get /di/groups/tags/{name}/members Retrieve a list of Members
GroupsApi MoveDirectory Put /di/groups/directories/{path}/directory/{targetParentPath} Move the Directory
GroupsApi MoveMember Put /di/groups/directories/{path}/members/{memberId} Move the Device or Gateway to the target directory
GroupsApi Parent Get /di/groups/directories/{path}/parent Retrieve the parent directory of this directory
GroupsApi Root Get /di/groups/directories/root Retrieve the Root Directory of the directory hierarchy
GroupsApi SetAttribute1 Put /di/groups/directories/{path}/attributes Add Attribute of a specific Directory
GroupsApi SetTagAttribute Put /di/groups/tags/{name}/attributes Add Attribute of a specific Tag
GroupsApi Tag Get /di/groups/tags/{name} Retrieve an existing Tag with a specified name
GroupsApi TagAttribute Get /di/groups/tags/{name}/attributes/{attributePath} Retrieve a specific Attribute of a specific Tag
GroupsApi TagMember Put /di/groups/tags/{name}/{memberId} Tag/Untag a Member of a Tag
GroupsApi Tags Get /di/groups/tags Retrieve a list of Tags matching the specified filter
RulesApi Action Get /mme/rules/{ruleId}/action Retrieve the Rule action
RulesApi CreateRule Post /mme/rules Create a Rule
RulesApi DeleteRule Delete /mme/rules/{ruleId} Delete the Rule
RulesApi EventMetadata Get /mme/rules/trigger/types/{triggerType}/eventsMetadata Retrieve a JSON schema of all possible events
RulesApi Fire Put /mme/rules/{ruleId}/tasks Fire the Rule manually
RulesApi GetActionDefMetada Get /mme/rules/actions/{actionType} Retrieve metadata in JSON schema format
RulesApi GetActionTypes Get /mme/rules/actions Retrieve all available registered Action types
RulesApi ListDevicesForRule Get /mme/rules/{ruleId}/devices Retrieve a list of all involved Devices
RulesApi ListRulesForDevice Get /mme/rules/devices/{deviceId} Retrieve all Rules involving a particular Device
RulesApi ListTasksForDeviceInRule Get /mme/rules/{ruleId}/devices/{deviceId}/tasks Retrieve all Tasks launched by the Rule which involve a specified Device
RulesApi Modify Put /mme/rules/{ruleId} Modify an existing Rule
RulesApi Options Get /mme/rules/{ruleId}/options Retrieve the Rule execution options
RulesApi Properties Get /mme/rules/{ruleId}/properties Get the custom Rule properties
RulesApi RetryDevice Put /mme/rules/{ruleId}/devices/{deviceId} Retry the Rule over the Device
RulesApi RetryDevices Put /mme/rules/{ruleId}/devices Retry the Rule over the Devices whose state satisfies the applied stateFilter
RulesApi Rule Get /mme/rules/{ruleId}/status Retrieve a Rule
RulesApi RuleDevice Get /mme/rules/{ruleId}/devices/{deviceId} Retrieve the execution status of a specified Device within the Rule
RulesApi Rules Get /mme/rules Retrieve all available Rules
RulesApi Scope Get /mme/rules/{ruleId}/scope Retrieve the Rule scope
RulesApi SetProperties Post /mme/rules/{ruleId}/properties Set custom Rule properties
RulesApi SetState Put /mme/rules/{ruleId}/state Enable or disable the Rule
RulesApi State Get /mme/rules/{ruleId}/state Retrieve the Rule state
RulesApi Tasks Get /mme/rules/{ruleId}/tasks Retrieve all Tasks launched by the Rule
RulesApi TriggerMetadata Get /mme/rules/trigger/types/{triggerType}/inputMetadata Retrieve a JSON schema of the required input
RulesApi TriggerTypes Get /mme/rules/trigger/types Retrieve all available registered Trigger types
TasksApi Action1 Get /mme/tasks/{taskId}/action Retrieve the Task action
TasksApi Cancel Put /mme/tasks/{taskId}/state Cancel the execution of this Task
TasksApi CancelDeviceInTask Put /mme/tasks/{taskId}/devices/{deviceId}/state Cancel the execution of this Task over a Device
TasksApi DeleteTask Delete /mme/tasks/{taskId} Delete a Task
TasksApi LaunchTask Post /mme/tasks Launch a Task
TasksApi ListDevicesForTask Get /mme/tasks/{taskId}/devices Retrieve all Devices involved in this Task
TasksApi ListExecutionsForDevice Get /mme/tasks/devices/{deviceId}/items Retrieve all Execution Items for a device
TasksApi ListTasksForDevice Get /mme/tasks/devices/{deviceId} Retrieve all Tasks and respective execution status for a particular Device
TasksApi Options1 Get /mme/tasks/{taskId}/options Retrieve the execution options of the Task
TasksApi Properties1 Get /mme/tasks/{taskId}/properties Get the custom properties assigned to this Task
TasksApi RetryDevice1 Put /mme/tasks/{taskId}/devices/{deviceId} Retry the Task over a Device
TasksApi RetryDevices1 Put /mme/tasks/{taskId}/devices Retry a Task over a particular Devices
TasksApi Rule1 Get /mme/tasks/{taskId}/rule Retrieve the Rule which launched this Task
TasksApi Scope1 Get /mme/tasks/{taskId}/scope Retrieve the Task scope
TasksApi SetProperties1 Post /mme/tasks/{taskId}/properties Set custom Task properties
TasksApi State1 Get /mme/tasks/{taskId}/state Retrieve the state of the Task
TasksApi Status Get /mme/tasks/{tasksId}/status Retrieve a Task status
TasksApi TaskDevice Get /mme/tasks/{taskId}/devices/{deviceId} Retrieve the Device task status in the scope of a Task
TasksApi Tasks1 Get /mme/tasks Retrieve all Tasks

Documentation For Models

Documentation For Authorization

SuiteAuth

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • offline: Offline Refresh Tokens
  • openid: OpenID

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

bearerAuth

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

refreshToken

  • Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
    Key: "APIKEY",
    Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	DevicesApi *DevicesApiService

	GroupsApi *GroupsApiService

	RulesApi *RulesApiService

	TasksApi *TasksApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Bosch IoT Manager API API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ActionInfo 

type ActionInfo struct {
	// The type of action used. All available action types can be listed through the method <code>ws/mme/rules/actions</code>
	ActionType string `json:"actionType"`
	// A JSON object, which should satisfy the metadata required for this action type. The metadata for the given action type is available through the method <code>ws/mme/rules/actions/{actionType}</code>
	ActionDef string `json:"actionDef"`
}

ActionInfo Groovy script and type defining the action for this Rule.

type Attribute 

type Attribute struct {
	// Attribute path
	Path string `json:"path"`
	// Attribute value
	Value map[string]interface{} `json:"value"`
}

Attribute struct for Attribute

type AttributeObject 

type AttributeObject struct {
	// Attribute path
	Path string `json:"path"`
	// Attribute value
	Value map[string]interface{} `json:"value"`
}

AttributeObject struct for AttributeObject

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl 

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

type Constraint 

type Constraint struct {
	Type  string `json:"type,omitempty"`
	Value string `json:"value,omitempty"`
}

Constraint struct for Constraint

type CreateAttributes1Opts 

type CreateAttributes1Opts struct {
	AttributeObject optional.Interface
}

CreateAttributes1Opts Optional parameters for the method 'CreateAttributes1'

type CreateAttributesOpts 

type CreateAttributesOpts struct {
	AttributeObject optional.Interface
}

CreateAttributesOpts Optional parameters for the method 'CreateAttributes'

type CreateDirectoryOpts 

type CreateDirectoryOpts struct {
	DirectoryParameters optional.Interface
}

CreateDirectoryOpts Optional parameters for the method 'CreateDirectory'

type CreateRuleOpts 

type CreateRuleOpts struct {
	RuleInfo optional.Interface
}

CreateRuleOpts Optional parameters for the method 'CreateRule'

type CreateTagAttributesOpts 

type CreateTagAttributesOpts struct {
	AttributeObject optional.Interface
}

CreateTagAttributesOpts Optional parameters for the method 'CreateTagAttributes'

type CreateTagOpts 

type CreateTagOpts struct {
	Parameters optional.Interface
}

CreateTagOpts Optional parameters for the method 'CreateTag'

type Credentials 

type Credentials struct {
	// The type of credentials. Values could be on of:  <ul>   <li>HASHED_PASSWORD - A credential type for storing a password for a device</li>   <li>PRE_SHARED_SECRET - A credential type for storing a Pre-shared Key as used in TLS handshakes</li>   <li>CERTIFICATE - A credential type for storing the formatted subject DN of a client certificate that is used to authenticate the device as part of a TLS handshake</li>  </ul>
	Type string `json:"type"`
	// The identity that the device should be authenticated as
	AuthId string `json:"authId,omitempty"`
	// Secret to authenticate the device against(valid for HASHED_PASSWORD and PRE_SHARED_SECRET type)
	Secret string `json:"secret,omitempty"`
	// If set to false the credentials are not supposed to be used to authenticate devices any longer.
	Enabled bool `json:"enabled,omitempty"`
}

Credentials Credentials are used to authenticate Devices connecting to the adapter. They could be of a certain type which indicates which authentication mechanism the credentials can be used with

type DefinitionIdentifier 

type DefinitionIdentifier struct {
	// Feature definition namespace
	Namespace string `json:"namespace"`
	// Feature definition name
	Name string `json:"name"`
	// Feature definition version
	Version string `json:"version"`
	// Feature definition namespace:name:value
	FullyQualifiedIdentifier string `json:"fullyQualifiedIdentifier"`
}

DefinitionIdentifier Feature definition identifiers

type DeleteDirectoryOpts 

type DeleteDirectoryOpts struct {
	Devices optional.Bool
}

DeleteDirectoryOpts Optional parameters for the method 'DeleteDirectory'

type Device 

type Device struct {
	Identifier Identifier `json:"identifier"`
	// Gateway identifier this device is attached to
	GatewayId string `json:"gatewayId,omitempty"`
	// Policy identifier
	PolicyId string `json:"policyId,omitempty"`
	// Device revision
	Revision int64 `json:"revision,omitempty"`
	// Modified timestamp
	Modified int64 `json:"modified,omitempty"`
	// The attributes that describe this entity
	Attributes []AttributeObject `json:"attributes,omitempty"`
	// Device features
	Features  []Feature              `json:"features,omitempty"`
	Attribute map[string]interface{} `json:"attribute,omitempty"`
}

Device struct for Device

type DeviceScopeInfo 

type DeviceScopeInfo struct {
	IdSelection     IdSelectionInfo     `json:"idSelection"`
	GroovySelection GroovySelectionInfo `json:"groovySelection"`
	GroupSelection  GroupSelectionInfo  `json:"groupSelection"`
}

DeviceScopeInfo The JSON Schema defines three pre-filled options in this order of priority - IdSelection, GroovySelection, GroupSelection - for defining Device Scope. Only one of them should be filled in. If several options are present - even if any of them is left empty or is invalid, all of them will be considered according to their order of priority.

type Devices1Opts 

type Devices1Opts struct {
	Filter     optional.String
	Namespaces optional.String
	Option     optional.String
	Fields     optional.String
}

Devices1Opts Optional parameters for the method 'Devices1'

type DevicesApiService 

type DevicesApiService service

DevicesApiService DevicesApi service

func (*DevicesApiService) Attribute 

func (a *DevicesApiService) Attribute(ctx _context.Context, deviceId string, attributePath string) (Attribute, *_nethttp.Response, error)

Attribute Retrieve a specific Attribute of a specific device Retrieve a specific Attribute of the device, identified by the &lt;code&gt;deviceId&lt;/code&gt; path parameter. The Attribute (JSON) can be referenced hierarchically by applying a JSON Pointer notation (RFC-6901), e.g.: /devices/{deviceId}/attributes/house/room in order to retrieve the house field of an room object.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId
  • @param attributePath

@return Attribute

func (*DevicesApiService) CreateAttributes 

func (a *DevicesApiService) CreateAttributes(ctx _context.Context, deviceId string, localVarOptionals *CreateAttributesOpts) (Attribute, *_nethttp.Response, error)

CreateAttributes Add Attributes of a specific Device Add Attributes of the specific Device. All previously existing attributes will be overwritten.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId
  • @param optional nil or *CreateAttributesOpts - Optional Parameters:
  • @param "AttributeObject" (optional.Interface of []AttributeObject) - List of Attributes

@return Attribute

func (*DevicesApiService) Definition 

func (a *DevicesApiService) Definition(ctx _context.Context, deviceId string, featureId string, fullyQualifiedIdentifier string) (FeatureDefinition, *_nethttp.Response, error)

Definition Retrieve the Definition of a Feature Retrieve the complete Definition of the Feature identified by the &lt;code&gt;deviceId&lt;/code&gt;, &lt;code&gt;featureId&lt;/code&gt; and &lt;code&gt;fullyQualifiedIdentifier&lt;code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId
  • @param featureId
  • @param fullyQualifiedIdentifier Pattern: ([_a-zA-Z0-9\\-.]+):([_a-zA-Z0-9\\-.]+):([_a-zA-Z0-9\\-.]+) A single fully qualified identifier of a Feature Definition in the form 'namespace:name:version'

@return FeatureDefinition

func (*DevicesApiService) Definitions 

func (a *DevicesApiService) Definitions(ctx _context.Context, deviceId string, featureId string) ([]FeatureDefinition, *_nethttp.Response, error)

Definitions List all Definitions of a Feature List all Definitions of the Feature identified by the &lt;code&gt;deviceId&lt;/code&gt; and &lt;code&gt;featureId&lt;/code&gt; path parameter.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId
  • @param featureId

@return []FeatureDefinition

func (*DevicesApiService) DeleteAttribute 

func (a *DevicesApiService) DeleteAttribute(ctx _context.Context, deviceId string, attributePath string) (*_nethttp.Response, error)

DeleteAttribute Delete Attribute of a specific Device Delete Attribute of a specific Device

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId
  • @param attributePath

func (*DevicesApiService) DeleteAttributes 

func (a *DevicesApiService) DeleteAttributes(ctx _context.Context, deviceId string) (*_nethttp.Response, error)

DeleteAttributes Delete Attributes of a specific Device Delete Attributes of a specific Device

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId

func (*DevicesApiService) Device 

func (a *DevicesApiService) Device(ctx _context.Context, deviceId string) (Device, *_nethttp.Response, error)

Device Retrieve an existing Device identified by the given deviceId Retrieve an existing Device identified by the given &lt;code&gt;deviceId&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId

@return Device

func (*DevicesApiService) Devices 

func (a *DevicesApiService) Devices(ctx _context.Context, gatewayId string, localVarOptionals *DevicesOpts) ([]Device, *_nethttp.Response, error)

Devices Retrieve a list of Edge Devices attached to the gateway Retrieve a list of edge devices attached to the gateway identified by &lt;code&gt;gatewayId&lt;/code&gt; and matching the given filter. Optionally, you can also use field selectors (see parameter fields) to get only the specified fields.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param gatewayId
  • @param optional nil or *DevicesOpts - Optional Parameters:
  • @param "Filter" (optional.String) - <h4>Filter operations:</h4><ui><li><tt>eq({property},{value})</tt></li><li><tt>ne({property},{value})</tt></li><li><tt>gt({property},{value})</tt></li><li><tt>ge({property},{value})</tt></li><li><tt>lt({property},{value})</tt></li><li><tt>le({property},{value})</tt></li><li><tt>in({property},{value},{value},...)</tt></li><li><tt>like({property},{value})</tt></li><li><tt>exists({property})</tt></li></ui>Note: When using filter operations, only devices with the specified properties are returned. For example, the filter ne(attributes/owner, \"SID123\") will only return devices that do have the owner attribute.<h4>Logical operations:</h4><ui><li><tt>and({query},{query},...)</tt></li><li><tt>or({query},{query},...)</tt></li><li><tt>not({query})</tt></li></ui><h5>Examples:</h5><ui><li><tt>eq(attributes/{attributeId},\"value\")</tt></li><li><tt>exists(features/{featureId}/properties/{category}/{propertyId}, value)</tt></li><li><tt>and(eq(attributes/{attributeId1},\"value\"),eq(attributes/{attributeId2},\"value\"))</tt></li></ui><b>Filters containing a wildcard * symbol at the beginning can slow down your search request.</b>
  • @param "Namespaces" (optional.String) - A comma separated list of namespaces. This list is used to limit the query to things in the given namespaces only. If this parameter is omitted, all registered namespaces of your solution will be queried.<h4>Examples:</h4><ul><li><tt>?namespaces=com.example.namespace</tt></li><li><tt>?namespaces=com.example.namespace1,com.example.namespace2</tt></li><li><tt>?fields=deviceId,attributes/location/longitude,attributes/address(city,street)</tt></li></ul>
  • @param "Option" (optional.String) - <p>Possible parameter values:</p><h5>Sort operations</h5><ul><li><tt>sort([+|-]{property})</tt></li><li><tt>sort([+|-]{property},[+|-]{property},...)</tt></li></ul><p><h5>Paging operations</h5><ul><li><tt>size({page-size}) Maximum allowed page size is 200. Default page size is 25.</tt></li><li><tt>cursor({cursor-id}) Start the search from the cursor location. Specify the cursor ID without quotation marks. Cursor IDs are given in search responses and mark the position after the last entry of the previous search. The meaning of cursor IDs is unspecified and may change without notice.</tt></li></ul><p><h4>Examples:</h4><ul><li><tt>sort(+id)</tt></li><li><tt>sort(-attributes/{attributePropertyValue})</tt></li><li><tt>size(10) return 10 results</tt></li><li><tt>cursor(LOREMIPSUM) return results after the position of the cursor LOREMIPSUM.</tt></li></ul><p><h5><b>Combine:</b></h5><p>If you need to specify multiple options, when using the swagger UI just write each option in a new line. When using the plain REST API programmatically, you will need to separate the options using a comma (,) character. size(200),cursor(LOREMIPSUM).
  • @param "Fields" (optional.String) - Contains a comma separated list of fields to be included in the returned JSON. Attributes can be selected in the same manner.<br><p><b>Selectable fields</b></p><ul><li><tt>ID</tt></li> <li><tt>policyId</tt></li><li><tt>attributes</tt><p>Supports selecting arbitrary sub-fields by using a comma separated list:</p><ul><li>several attribute paths can be passed as a comma separated list of JSON pointers (RFC-6901)<br><br><b>For example:</b><br><ul><li><tt>?fields=attributes/{attributeId}/{attributeValue}</tt> would select only attribute value (if present)</li><li><tt>?fields=attributes/{attributeId1}/{attributeValue},attributes/{attributeId2}/{attributeValue}</tt></li><li><tt>?fields=attributes/{attributeId1}/{attributeValue1},attributes/{attributeId1}/{attributeValue2}</tt></li></ul></li><li>a comma-separated list of sub-fields (a sub-field is a JSON pointer (RFC-6901) separated with /) to select </li><li>sub-selectors can be used to request only specific sub-fields by placing expressions in parentheses ( ) after a selected subfield<br><b>For example:</b><br><ul><li><tt>?fields=attributes/{attributeId}/(attributeValue1,attributeValue2)</tt></li></ul></li></ul></li><li><tt>features</tt><p>Supports selecting arbitrary fields in features similar to attributes</p><b>features/{featureId}/properties/{category}/{propertyId}</b></li></ul><h4>Examples:</h4><ul><li><tt>?fields=id,attributes,features</tt></li><li><tt>?fields=attributes/{attributeId1}(attributeValue1,attributeValue1),features</tt></li><li><tt>?fields=id,attributes/{attributeId1},features/{featureId}/properties/{category}/{propertyId}</tt></li></ul>

@return []Device

func (*DevicesApiService) Devices1 

func (a *DevicesApiService) Devices1(ctx _context.Context, localVarOptionals *Devices1Opts) ([]Device, *_nethttp.Response, error)

Devices1 Retrieve all Devices Retrieve a list of devices matching the given filter. Optionally, you can also use field.selectors (see parameter fields) to get only the specified fields.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *Devices1Opts - Optional Parameters:
  • @param "Filter" (optional.String) - <h4>Filter operations:</h4><ui><li><tt>eq({property},{value})</tt></li><li><tt>ne({property},{value})</tt></li><li><tt>gt({property},{value})</tt></li><li><tt>ge({property},{value})</tt></li><li><tt>lt({property},{value})</tt></li><li><tt>le({property},{value})</tt></li><li><tt>in({property},{value},{value},...)</tt></li><li><tt>like({property},{value})</tt></li><li><tt>exists({property})</tt></li></ui>Note: When using filter operations, only devices with the specified properties are returned. For example, the filter ne(attributes/owner, \"SID123\") will only return devices that do have the owner attribute.<h4>Logical operations:</h4><ui><li><tt>and({query},{query},...)</tt></li><li><tt>or({query},{query},...)</tt></li><li><tt>not({query})</tt></li></ui><h5>Examples:</h5><ui><li><tt>eq(attributes/{attributeId},\"value\")</tt></li><li><tt>exists(features/{featureId}/properties/{category}/{propertyId}, value)</tt></li><li><tt>and(eq(attributes/{attributeId1},\"value\"),eq(attributes/{attributeId2},\"value\"))</tt></li></ui><b>Filters containing a wildcard * symbol at the beginning can slow down your search request.</b>
  • @param "Namespaces" (optional.String) - A comma separated list of namespaces. This list is used to limit the query to things in the given namespaces only. If this parameter is omitted, all registered namespaces of your solution will be queried.<h4>Examples:</h4><ul><li><tt>?namespaces=com.example.namespace</tt></li><li><tt>?namespaces=com.example.namespace1,com.example.namespace2</tt></li><li><tt>?fields=deviceId,attributes/location/longitude,attributes/address(city,street)</tt></li></ul>
  • @param "Option" (optional.String) - <p>Possible parameter values:</p><h5>Sort operations</h5><ul><li><tt>sort([+|-]{property})</tt></li><li><tt>sort([+|-]{property},[+|-]{property},...)</tt></li></ul><p><h5>Paging operations</h5><ul><li><tt>size({page-size}) Maximum allowed page size is 200. Default page size is 25.</tt></li><li><tt>cursor({cursor-id}) Start the search from the cursor location. Specify the cursor ID without quotation marks. Cursor IDs are given in search responses and mark the position after the last entry of the previous search. The meaning of cursor IDs is unspecified and may change without notice.</tt></li></ul><p><h4>Examples:</h4><ul><li><tt>sort(+id)</tt></li><li><tt>sort(-attributes/{attributePropertyValue})</tt></li><li><tt>size(10) return 10 results</tt></li><li><tt>cursor(LOREMIPSUM) return results after the position of the cursor LOREMIPSUM.</tt></li></ul><p><h5><b>Combine:</b></h5><p>If you need to specify multiple options, when using the swagger UI just write each option in a new line. When using the plain REST API programmatically, you will need to separate the options using a comma (,) character. size(200),cursor(LOREMIPSUM).
  • @param "Fields" (optional.String) - Contains a comma separated list of fields to be included in the returned JSON. Attributes can be selected in the same manner.<br><p><b>Selectable fields</b></p><ul><li><tt>ID</tt></li> <li><tt>policyId</tt></li><li><tt>attributes</tt><p>Supports selecting arbitrary sub-fields by using a comma separated list:</p><ul><li>several attribute paths can be passed as a comma separated list of JSON pointers (RFC-6901)<br><br><b>For example:</b><br><ul><li><tt>?fields=attributes/{attributeId}/{attributeValue}</tt> would select only attribute value (if present)</li><li><tt>?fields=attributes/{attributeId1}/{attributeValue},attributes/{attributeId2}/{attributeValue}</tt></li><li><tt>?fields=attributes/{attributeId1}/{attributeValue1},attributes/{attributeId1}/{attributeValue2}</tt></li></ul></li><li>a comma-separated list of sub-fields (a sub-field is a JSON pointer (RFC-6901) separated with /) to select </li><li>sub-selectors can be used to request only specific sub-fields by placing expressions in parentheses ( ) after a selected subfield<br><b>For example:</b><br><ul><li><tt>?fields=attributes/{attributeId}/(attributeValue1,attributeValue2)</tt></li></ul></li></ul></li><li><tt>features</tt><p>Supports selecting arbitrary fields in features similar to attributes</p><b>features/{featureId}/properties/{category}/{propertyId}</b></li></ul><h4>Examples:</h4><ul><li><tt>?fields=id,attributes,features</tt></li><li><tt>?fields=attributes/{attributeId1}(attributeValue1,attributeValue1),features</tt></li><li><tt>?fields=id,attributes/{attributeId1},features/{featureId}/properties/{category}/{propertyId}</tt></li></ul>

@return []Device

func (*DevicesApiService) DevicesCount 

func (a *DevicesApiService) DevicesCount(ctx _context.Context, localVarOptionals *DevicesCountOpts) (*_nethttp.Response, error)

DevicesCount Retrieve the number of Devices matching the given filter Retrieve the number of devices matching the given filter.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *DevicesCountOpts - Optional Parameters:
  • @param "Filter" (optional.String) - <h4>Filter operations:</h4><ui><li><tt>eq({property},{value})</tt></li><li><tt>ne({property},{value})</tt></li><li><tt>gt({property},{value})</tt></li><li><tt>ge({property},{value})</tt></li><li><tt>lt({property},{value})</tt></li><li><tt>le({property},{value})</tt></li><li><tt>in({property},{value},{value},...)</tt></li><li><tt>like({property},{value})</tt></li><li><tt>exists({property})</tt></li></ui>Note: When using filter operations, only devices with the specified properties are returned. For example, the filter ne(attributes/owner, \"SID123\") will only return devices that do have the owner attribute.<h4>Logical operations:</h4><ui><li><tt>and({query},{query},...)</tt></li><li><tt>or({query},{query},...)</tt></li><li><tt>not({query})</tt></li></ui><h5>Examples:</h5><ui><li><tt>eq(attributes/{attributeId},\"value\")</tt></li><li><tt>exists(features/{featureId}/properties/{category}/{propertyId}, value)</tt></li><li><tt>and(eq(attributes/{attributeId1},\"value\"),eq(attributes/{attributeId2},\"value\"))</tt></li></ui><b>Filters containing a wildcard * symbol at the beginning can slow down your search request.</b>

func (*DevicesApiService) DevicesCount1 

func (a *DevicesApiService) DevicesCount1(ctx _context.Context, gatewayId string, localVarOptionals *DevicesCount1Opts) (*_nethttp.Response, error)

DevicesCount1 Retrieve the number of Devices matching the given filter Retrieve the number of devices matching the given filter.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param gatewayId
  • @param optional nil or *DevicesCount1Opts - Optional Parameters:
  • @param "Filter" (optional.String) - <h4>Filter operations:</h4><ui><li><tt>eq({property},{value})</tt></li><li><tt>ne({property},{value})</tt></li><li><tt>gt({property},{value})</tt></li><li><tt>ge({property},{value})</tt></li><li><tt>lt({property},{value})</tt></li><li><tt>le({property},{value})</tt></li><li><tt>in({property},{value},{value},...)</tt></li><li><tt>like({property},{value})</tt></li><li><tt>exists({property})</tt></li></ui>Note: When using filter operations, only devices with the specified properties are returned. For example, the filter ne(attributes/owner, \"SID123\") will only return devices that do have the owner attribute.<h4>Logical operations:</h4><ui><li><tt>and({query},{query},...)</tt></li><li><tt>or({query},{query},...)</tt></li><li><tt>not({query})</tt></li></ui><h5>Examples:</h5><ui><li><tt>eq(attributes/{attributeId},\"value\")</tt></li><li><tt>exists(features/{featureId}/properties/{category}/{propertyId}, value)</tt></li><li><tt>and(eq(attributes/{attributeId1},\"value\"),eq(attributes/{attributeId2},\"value\"))</tt></li></ui><b>Filters containing a wildcard * symbol at the beginning can slow down your search request.</b>

func (*DevicesApiService) Feature 

func (a *DevicesApiService) Feature(ctx _context.Context, deviceId string, featureId string) (Feature, *_nethttp.Response, error)

Feature Retrieve a Feature of a Device Retrieve a Feature of the Device identified by the deviceId path parameter.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId
  • @param featureId

@return Feature

func (*DevicesApiService) FeatureProperties 

func (a *DevicesApiService) FeatureProperties(ctx _context.Context, deviceId string, featureId string) ([]Property, *_nethttp.Response, error)

FeatureProperties List the Properties of a Feature Retrieve the complete Properties of the Feature identified by the &lt;code&gt;deviceId&lt;/code&gt; and &lt;code&gt;featureId&lt;/code&gt; path parameter.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId
  • @param featureId

@return []Property

func (*DevicesApiService) Features 

func (a *DevicesApiService) Features(ctx _context.Context, deviceId string) ([]Feature, *_nethttp.Response, error)

Features List all Features of a specific device Retrieve all Features of the Device identified by the &lt;code&gt;deviceId&lt;/code&gt; path parameter.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId

@return []Feature

func (*DevicesApiService) Gateway 

func (a *DevicesApiService) Gateway(ctx _context.Context, gatewayId string) ([]Gateway, *_nethttp.Response, error)

Gateway Retrieve an existing Gateway identified by the given gatewayId Retrieve an existing Gateway identified by the given gatewayId.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param gatewayId

@return []Gateway

func (*DevicesApiService) Gateways 

func (a *DevicesApiService) Gateways(ctx _context.Context, localVarOptionals *GatewaysOpts) ([]Gateway, *_nethttp.Response, error)

Gateways Retrieve all Gateways Retrieve a list of gateways matching the given filter. Optionally, you can also use field selectors (see parameter fields) to get only specified fields.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GatewaysOpts - Optional Parameters:
  • @param "Filter" (optional.String) - <h4>Filter operations:</h4><ui><li><tt>eq({property},{value})</tt></li><li><tt>ne({property},{value})</tt></li><li><tt>gt({property},{value})</tt></li><li><tt>ge({property},{value})</tt></li><li><tt>lt({property},{value})</tt></li><li><tt>le({property},{value})</tt></li><li><tt>in({property},{value},{value},...)</tt></li><li><tt>like({property},{value})</tt></li><li><tt>exists({property})</tt></li></ui>Note: When using filter operations, only devices with the specified properties are returned. For example, the filter ne(attributes/owner, \"SID123\") will only return devices that do have the owner attribute.<h4>Logical operations:</h4><ui><li><tt>and({query},{query},...)</tt></li><li><tt>or({query},{query},...)</tt></li><li><tt>not({query})</tt></li></ui><h5>Examples:</h5><ui><li><tt>eq(attributes/{attributeId},\"value\")</tt></li><li><tt>exists(features/{featureId}/properties/{category}/{propertyId}, value)</tt></li><li><tt>and(eq(attributes/{attributeId1},\"value\"),eq(attributes/{attributeId2},\"value\"))</tt></li></ui><b>Filters containing a wildcard * symbol at the beginning can slow down your search request.</b>
  • @param "Namespaces" (optional.String) - A comma separated list of namespaces. This list is used to limit the query to things in the given namespaces only. If this parameter is omitted, all registered namespaces of your solution will be queried.<h4>Examples:</h4><ul><li><tt>?namespaces=com.example.namespace</tt></li><li><tt>?namespaces=com.example.namespace1,com.example.namespace2</tt></li><li><tt>?fields=deviceId,attributes/location/longitude,attributes/address(city,street)</tt></li></ul>
  • @param "Option" (optional.String) - <p>Possible parameter values:</p><h5>Sort operations</h5><ul><li><tt>sort([+|-]{property})</tt></li><li><tt>sort([+|-]{property},[+|-]{property},...)</tt></li></ul><p><h5>Paging operations</h5><ul><li><tt>size({page-size}) Maximum allowed page size is 200. Default page size is 25.</tt></li><li><tt>cursor({cursor-id}) Start the search from the cursor location. Specify the cursor ID without quotation marks. Cursor IDs are given in search responses and mark the position after the last entry of the previous search. The meaning of cursor IDs is unspecified and may change without notice.</tt></li></ul><p><h4>Examples:</h4><ul><li><tt>sort(+id)</tt></li><li><tt>sort(-attributes/{attributePropertyValue})</tt></li><li><tt>size(10) return 10 results</tt></li><li><tt>cursor(LOREMIPSUM) return results after the position of the cursor LOREMIPSUM.</tt></li></ul><p><h5><b>Combine:</b></h5><p>If you need to specify multiple options, when using the swagger UI just write each option in a new line. When using the plain REST API programmatically, you will need to separate the options using a comma (,) character. size(200),cursor(LOREMIPSUM).
  • @param "Fields" (optional.String) - Contains a comma separated list of fields to be included in the returned JSON. Attributes can be selected in the same manner.<br><p><b>Selectable fields</b></p><ul><li><tt>ID</tt></li> <li><tt>policyId</tt></li><li><tt>attributes</tt><p>Supports selecting arbitrary sub-fields by using a comma separated list:</p><ul><li>several attribute paths can be passed as a comma separated list of JSON pointers (RFC-6901)<br><br><b>For example:</b><br><ul><li><tt>?fields=attributes/{attributeId}/{attributeValue}</tt> would select only attribute value (if present)</li><li><tt>?fields=attributes/{attributeId1}/{attributeValue},attributes/{attributeId2}/{attributeValue}</tt></li><li><tt>?fields=attributes/{attributeId1}/{attributeValue1},attributes/{attributeId1}/{attributeValue2}</tt></li></ul></li><li>a comma-separated list of sub-fields (a sub-field is a JSON pointer (RFC-6901) separated with /) to select </li><li>sub-selectors can be used to request only specific sub-fields by placing expressions in parentheses ( ) after a selected subfield<br><b>For example:</b><br><ul><li><tt>?fields=attributes/{attributeId}/(attributeValue1,attributeValue2)</tt></li></ul></li></ul></li><li><tt>features</tt><p>Supports selecting arbitrary fields in features similar to attributes</p><b>features/{featureId}/properties/{category}/{propertyId}</b></li></ul><h4>Examples:</h4><ul><li><tt>?fields=id,attributes,features</tt></li><li><tt>?fields=attributes/{attributeId1}(attributeValue1,attributeValue1),features</tt></li><li><tt>?fields=id,attributes/{attributeId1},features/{featureId}/properties/{category}/{propertyId}</tt></li></ul>

@return []Gateway

func (*DevicesApiService) GatewaysCount 

func (a *DevicesApiService) GatewaysCount(ctx _context.Context, localVarOptionals *GatewaysCountOpts) (*_nethttp.Response, error)

GatewaysCount Retrieve the number of gateways matching the given filter Retrieve the number of gateways matching the given filter.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GatewaysCountOpts - Optional Parameters:
  • @param "Filter" (optional.String) - <h4>Filter operations:</h4><ui><li><tt>eq({property},{value})</tt></li><li><tt>ne({property},{value})</tt></li><li><tt>gt({property},{value})</tt></li><li><tt>ge({property},{value})</tt></li><li><tt>lt({property},{value})</tt></li><li><tt>le({property},{value})</tt></li><li><tt>in({property},{value},{value},...)</tt></li><li><tt>like({property},{value})</tt></li><li><tt>exists({property})</tt></li></ui>Note: When using filter operations, only devices with the specified properties are returned. For example, the filter ne(attributes/owner, \"SID123\") will only return devices that do have the owner attribute.<h4>Logical operations:</h4><ui><li><tt>and({query},{query},...)</tt></li><li><tt>or({query},{query},...)</tt></li><li><tt>not({query})</tt></li></ui><h5>Examples:</h5><ui><li><tt>eq(attributes/{attributeId},\"value\")</tt></li><li><tt>exists(features/{featureId}/properties/{category}/{propertyId}, value)</tt></li><li><tt>and(eq(attributes/{attributeId1},\"value\"),eq(attributes/{attributeId2},\"value\"))</tt></li></ui><b>Filters containing a wildcard * symbol at the beginning can slow down your search request.</b>

func (*DevicesApiService) ListAttributes 

func (a *DevicesApiService) ListAttributes(ctx _context.Context, deviceId string) ([]Attribute, *_nethttp.Response, error)

ListAttributes List all Attributes of a specific Device List all Attributes of a specific Device

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId

@return []Attribute

func (*DevicesApiService) Property 

func (a *DevicesApiService) Property(ctx _context.Context, deviceId string, featureId string, propertyName string) (Property, *_nethttp.Response, error)

Property Retrieve the Property of a Feature Retrieve the complete Property of the Feature identified by the &lt;code&gt;deviceId&lt;/code&gt; and &lt;code&gt;featureId&lt;/code&gt; path parameter.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId
  • @param featureId
  • @param propertyName

@return Property

func (*DevicesApiService) Register 

func (a *DevicesApiService) Register(ctx _context.Context, deviceId string, localVarOptionals *RegisterOpts) (Property, *_nethttp.Response, error)

Register Register a specific Device Register a specific Device.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId Device ID
  • @param optional nil or *RegisterOpts - Optional Parameters:
  • @param "RegisterInfo" (optional.Interface of RegisterInfo) - Registration info

@return Property

func (*DevicesApiService) SetAttribute 

func (a *DevicesApiService) SetAttribute(ctx _context.Context, deviceId string, localVarOptionals *SetAttributeOpts) (Attribute, *_nethttp.Response, error)

SetAttribute Add Attribute of a specific Device Add Attribute of the specific Device. If an attribute with the same path already exists it will be overwritten.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId
  • @param optional nil or *SetAttributeOpts - Optional Parameters:
  • @param "Attribute" (optional.Interface of Attribute) - Directory

@return Attribute

func (*DevicesApiService) Unregister 

func (a *DevicesApiService) Unregister(ctx _context.Context, deviceId string, localVarOptionals *UnregisterOpts) (Property, *_nethttp.Response, error)

Unregister Unregister a specific Device Unregister a specific Device.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId Device ID
  • @param optional nil or *UnregisterOpts - Optional Parameters:
  • @param "KeepCredentials" (optional.Bool) -
  • @param "KeepPolicy" (optional.Bool) -

@return Property

type DevicesCount1Opts 

type DevicesCount1Opts struct {
	Filter optional.String
}

DevicesCount1Opts Optional parameters for the method 'DevicesCount1'

type DevicesCountOpts 

type DevicesCountOpts struct {
	Filter optional.String
}

DevicesCountOpts Optional parameters for the method 'DevicesCount'

type DevicesOpts 

type DevicesOpts struct {
	Filter     optional.String
	Namespaces optional.String
	Option     optional.String
	Fields     optional.String
}

DevicesOpts Optional parameters for the method 'Devices'

type DirectoriesOpts 

type DirectoriesOpts struct {
	Filter optional.String
	Option optional.String
}

DirectoriesOpts Optional parameters for the method 'Directories'

type Directory 

type Directory struct {
	Identifier Identifier `json:"identifier"`
	// The attributes that describe this entity
	Attributes []AttributeObject `json:"attributes,omitempty"`
	// The name of this entity
	Name string `json:"name"`
	// The path of this directory in the directory tree
	Path      string                 `json:"path"`
	Attribute map[string]interface{} `json:"attribute,omitempty"`
}

Directory struct for Directory

type DirectoryMembersOpts 

type DirectoryMembersOpts struct {
	Devices    optional.Bool
	Recursive  optional.Bool
	Filter     optional.String
	Namespaces optional.String
	Option     optional.String
	Fields     optional.String
}

DirectoryMembersOpts Optional parameters for the method 'DirectoryMembers'

type DirectoryParameters 

type DirectoryParameters struct {
	Identifier Identifier        `json:"identifier,omitempty"`
	Attributes []AttributeObject `json:"attributes,omitempty"`
	// User-friendly name
	Name string `json:"name"`
	// Parent directory path
	ParentPath string `json:"parentPath,omitempty"`
}

DirectoryParameters struct for DirectoryParameters

type ErrorEntity 

type ErrorEntity struct {
	// The message of the error
	Message string `json:"message"`
	// The HTTP status code of the error
	StatusCode  int32  `json:"statusCode"`
	ErrorCode   int32  `json:"errorCode,omitempty"`
	Description string `json:"description,omitempty"`
	UID         string `json:"UID,omitempty"`
}

ErrorEntity The advanced HTTP error response handling

type ExecOptInfo 

type ExecOptInfo struct {
	//   Defines whether multiple Tasks over the same device can overlap or should be replaced. This option is applicable only for Rules. Overlapping: <li> ALLOW_OVERLAPPING_TASKS(0): No relation constraint between Tasks. New Tasks can be triggered, although old Tasks are still active. This option should be used very carefully due to possible accumulation (explosion) of unfinished Tasks. </li> <li>NO_OVERLAPPING_CANCEL_OLD(1) : In case of Rule firing for a particular device, any previous executions still running for this device in the scope of the same Rule will be canceled. </li><li> NO_OVERLAPPING_KEEP_OLD_SKIP_NEW(2): Skip triggering a new Task for devices that already have unfinished Tasks in the scope of the Rule.;
	OverlapOption int32 `json:"overlapOption,omitempty"`
	// Restricts the maximum number of devices concurrently executing a Task or Rule.
	ConcurrencyLimit int32 `json:"concurrencyLimit"`
	// Timeout in seconds after which a non-confirmed execution expires and stops occupying room in the concurrency limit. The default value is 30 seconds.
	ConcurrencyTimeout int32 `json:"concurrencyTimeout,omitempty"`
	// If the Rule should be triggered no more than once for the same device, false otherwise
	OncePerDevice bool `json:"oncePerDevice,omitempty"`
	// If the Rule should be automatically disabled once all targets from the Scope pass through the triggering conditions, false otherwise
	AutoDisable bool `json:"autoDisable,omitempty"`
	// A time schedule in which the Task execution is permitted. The time schedule constraint must be provided as a cron expression. <code>Example:</code> <li/>* * 9-17 ? * MON-FRI: defines that the execution time will be on working days (Monday to Friday) between 9.00-17.00h<li/>* * 00-01 * * ?: defines that execution time will be every day between 00-01 in the morning.<li/>* * * 01 * ?: defines that execution time will be on the 1st day of each month .
	TimeConstraint string `json:"timeConstraint"`
}

ExecOptInfo Execution options of this Rule

type Feature 

type Feature struct {
	// Feature identifier
	Id string `json:"id"`
	// Feature properties
	Properties []PropertyObject `json:"properties,omitempty"`
	// Feature definition identifiers
	Definitions []DefinitionIdentifier `json:"definitions,omitempty"`
}

Feature Device features

type FeatureDefinition 

type FeatureDefinition struct {
	Id    DefinitionIdentifier `json:"id"`
	Model FunctionBlock        `json:"model"`
}

FeatureDefinition struct for FeatureDefinition

type FunctionBlock 

type FunctionBlock struct {
	Id                      ModelId         `json:"id,omitempty"`
	Type                    string          `json:"type,omitempty"`
	DisplayName             string          `json:"displayName,omitempty"`
	Description             string          `json:"description,omitempty"`
	FileName                string          `json:"fileName,omitempty"`
	References              []ModelId       `json:"references,omitempty"`
	ConfigurationProperties []ModelProperty `json:"configurationProperties,omitempty"`
	StatusProperties        []ModelProperty `json:"statusProperties,omitempty"`
	FaultProperties         []ModelProperty `json:"faultProperties,omitempty"`
	Events                  []ModelEvent    `json:"events,omitempty"`
	Operations              []Operation     `json:"operations,omitempty"`
}

FunctionBlock Feature definition Function Block

type Gateway 

type Gateway struct {
	Identifier Identifier `json:"identifier"`
	// Gateway identifier this device is attached to
	GatewayId string `json:"gatewayId,omitempty"`
	// Policy identifier
	PolicyId string `json:"policyId,omitempty"`
	// The attributes that describe this entity
	Attributes []AttributeObject `json:"attributes,omitempty"`
	// Device features
	Features []Feature `json:"features,omitempty"`
	// Device revision
	Revision int64 `json:"revision,omitempty"`
	// Modified timestamp
	Modified  int64                  `json:"modified,omitempty"`
	Attribute map[string]interface{} `json:"attribute,omitempty"`
}

Gateway struct for Gateway

type GatewaysCountOpts 

type GatewaysCountOpts struct {
	Filter optional.String
}

GatewaysCountOpts Optional parameters for the method 'GatewaysCount'

type GatewaysOpts 

type GatewaysOpts struct {
	Filter     optional.String
	Namespaces optional.String
	Option     optional.String
	Fields     optional.String
}

GatewaysOpts Optional parameters for the method 'Gateways'

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GroovySelectionInfo 

type GroovySelectionInfo struct {
	// Custom Groovy listing script which dynamically includes devices in the selection
	ListingScript string `json:"listingScript"`
	// A custom Groovy filtering script which is used to narrow down the devices belonging to this selection. If present, only devices satisfying this script will be included in the selection.
	FilteringScript string `json:"filteringScript,omitempty"`
}

GroovySelectionInfo A Dynamic selection of devices determined by a custom Groovy listing script.

type GroupSelectionInfo 

type GroupSelectionInfo struct {
	// Path of the directory whose devices belong to this selection
	DirectoryPath string `json:"directoryPath"`
	// Indicates whether devices from the entire subtree (true) or only direct members (false) of the given directory are included in this selection
	Recursive bool `json:"recursive,omitempty"`
	// Indicates whether only gateways are included in this selection.
	GatewaysOnly bool `json:"gatewaysOnly,omitempty"`
	// List of tag names to further narrow down the selection - only devices belonging to the given directory and tagged with the given tags are included in this selection.
	Tags []string `json:"tags,omitempty"`
	// RQL filter query which is used to narrow down the devices belonging to this selection. If present, only devices matching this query will be present in the selection.
	RqlQuery string `json:"rqlQuery,omitempty"`
	// A custom Groovy filtering script which is used to narrow down the devices belonging to this selection. If present, only devices satisfying this script will be included in the selection.
	FilteringScript string `json:"filteringScript,omitempty"`
}

GroupSelectionInfo A Selection composed of a group of devices.

type GroupsApiService 

type GroupsApiService service

GroupsApiService GroupsApi service

func (*GroupsApiService) Attribute1 

func (a *GroupsApiService) Attribute1(ctx _context.Context, path string, attributePath string) (Attribute, *_nethttp.Response, error)

Attribute1 Retrieve a specific Attribute of a specific device Retrieve a specific Attribute of the Directory, identified by the &lt;code&gt;path&lt;/code&gt; parameter. The Attribute (JSON) can be referenced hierarchically by applying a JSON Pointer notation (RFC-6901), e.g.: /directories/{path}/attributes/house/room in order to retrieve the house field of an room object.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param path
  • @param attributePath

@return Attribute

func (*GroupsApiService) CreateAttributes1 

func (a *GroupsApiService) CreateAttributes1(ctx _context.Context, path string, localVarOptionals *CreateAttributes1Opts) (Directory, *_nethttp.Response, error)

CreateAttributes1 Add Attributes of a specific Directory Add Attributes of the specific Directory. All previously existing attributes will be overwritten.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param path
  • @param optional nil or *CreateAttributes1Opts - Optional Parameters:
  • @param "AttributeObject" (optional.Interface of []AttributeObject) - List of Attributes

@return Directory

func (*GroupsApiService) CreateDirectory 

func (a *GroupsApiService) CreateDirectory(ctx _context.Context, localVarOptionals *CreateDirectoryOpts) (Directory, *_nethttp.Response, error)

CreateDirectory Add a Directory to the directory hierarchy Add a directory to the directory hierarchy.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *CreateDirectoryOpts - Optional Parameters:
  • @param "DirectoryParameters" (optional.Interface of DirectoryParameters) - Directory

@return Directory

func (*GroupsApiService) CreateTag 

func (a *GroupsApiService) CreateTag(ctx _context.Context, localVarOptionals *CreateTagOpts) (Tag, *_nethttp.Response, error)

CreateTag Create a Tag Create a tag according to the specified parameters.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *CreateTagOpts - Optional Parameters:
  • @param "Parameters" (optional.Interface of Parameters) - Create new tag

@return Tag

func (*GroupsApiService) CreateTagAttributes 

func (a *GroupsApiService) CreateTagAttributes(ctx _context.Context, name string, localVarOptionals *CreateTagAttributesOpts) (Directory, *_nethttp.Response, error)

CreateTagAttributes Add Attributes of a specific Tag Add Attributes of the specific Tag. All previously existing attributes will be overwritten.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name
  • @param optional nil or *CreateTagAttributesOpts - Optional Parameters:
  • @param "AttributeObject" (optional.Interface of []AttributeObject) - List of Attributes

@return Directory

func (*GroupsApiService) DeleteAttribute1 

func (a *GroupsApiService) DeleteAttribute1(ctx _context.Context, path string, attributePath string) (*_nethttp.Response, error)

DeleteAttribute1 Delete Attribute of a specific Directory Delete Attribute of a specific Directory

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param path
  • @param attributePath

func (*GroupsApiService) DeleteAttributes1 

func (a *GroupsApiService) DeleteAttributes1(ctx _context.Context, path string) (*_nethttp.Response, error)

DeleteAttributes1 Delete Attributes of a specific Directory Delete Attributes of a specific Directory

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param path

func (*GroupsApiService) DeleteDirectory 

func (a *GroupsApiService) DeleteDirectory(ctx _context.Context, path string, localVarOptionals *DeleteDirectoryOpts) (*_nethttp.Response, error)

DeleteDirectory Delete an existing directory from the directory hierarchy Delete an existing directory from the directory tree. If the devices parameter&#39;s value is &lt;code&gt;true&lt;/code&gt; the devices under the directory will be deleted as well, if the value is &lt;code&gt;false&lt;/code&gt;, these devices will still be listed under the root, even after the directory is deleted.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param path The path of a directory in the directory tree
  • @param optional nil or *DeleteDirectoryOpts - Optional Parameters:
  • @param "Devices" (optional.Bool) - If the value of the members' parameter is <code>true</code> the members under the directory should be deleted as well.

func (*GroupsApiService) DeleteTag 

func (a *GroupsApiService) DeleteTag(ctx _context.Context, name string) (*_nethttp.Response, error)

DeleteTag Delete a Tag Delete a tag with the specified name.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name The name of the tag

func (*GroupsApiService) DeleteTagAttribute 

func (a *GroupsApiService) DeleteTagAttribute(ctx _context.Context, name string, attributePath string) (*_nethttp.Response, error)

DeleteTagAttribute Add Attribute of a specific Tag Add Attribute of a specific Tag

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name
  • @param attributePath

func (*GroupsApiService) DeleteTagAttributes 

func (a *GroupsApiService) DeleteTagAttributes(ctx _context.Context, name string) (*_nethttp.Response, error)

DeleteTagAttributes Add Attributes of a specific Tag Add Attributes of a specific Tag

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name

func (*GroupsApiService) Directories 

func (a *GroupsApiService) Directories(ctx _context.Context, localVarOptionals *DirectoriesOpts) ([]Directory, *_nethttp.Response, error)

Directories List all Directories Retrieve a list of directories matching the given filter. Optionally, you can also use field selectors (see parameter fields) to get only the specified fields.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *DirectoriesOpts - Optional Parameters:
  • @param "Filter" (optional.String) - <h4>Filter operations:</h4><ui><li><tt>eq({property},{value})</tt></li><li><tt>ne({property},{value})</tt></li><li><tt>gt({property},{value})</tt></li><li><tt>ge({property},{value})</tt></li><li><tt>lt({property},{value})</tt></li><li><tt>le({property},{value})</tt></li><li><tt>in({property},{value},{value},...)</tt></li><li><tt>like({property},{value})</tt></li><li><tt>exists({property})</tt></li></ui>Note: When using filter operations, only directories with the specified properties are returned. For example, the filter ne(name, \"specifiedName\") will only return directories that do have the specifiedName name.<h4>Logical operations:</h4><ui><li><tt>and({query},{query},...)</tt></li><li><tt>or({query},{query},...)</tt></li><li><tt>not({query})</tt></li></ui><h5>Examples:</h5><ui><li><tt>eq({id},\"value\")</tt></li><li><tt>exists({path}, value)</tt></li><li><tt>and(eq({path},\"value\"),eq({name},\"value\"))</tt></li></ui><b>Filters containing a wildcard * symbol at the beginning can slow down your search request.</b>
  • @param "Option" (optional.String) - <p>Possible parameter values:</p><h5>Sort operations</h5><ul><li><tt>sort([+|-]{property})</tt></li><li><tt>sort([+|-]{property},[+|-]{property},...)</tt></li></ul><p><h5>Paging operations</h5><ul><li><tt>size({page-size}) Maximum allowed page size is 200. Default page size is 25.</tt></li><li><tt>cursor({cursor-id}) Start the search from the cursor location. Specify the cursor ID without quotation marks. Cursor IDs are given in search responses and mark the position after the last entry of the previous search. The meaning of cursor IDs is unspecified and may change without notice.</tt></li></ul><p><h4>Examples:</h4><ul><li><tt>sort(+id)</tt></li><li><tt>sort(-attributes/{attributePropertyValue})</tt></li><li><tt>size(10) return 10 results</tt></li><li><tt>cursor(LOREMIPSUM) return results after the position of the cursor LOREMIPSUM.</tt></li></ul><p><h5><b>Combine:</b></h5><p>If you need to specify multiple options, when using the swagger UI just write each option in a new line. When using the plain REST API programmatically, you will need to separate the options using a comma (,) character. size(200),cursor(LOREMIPSUM).

@return []Directory

func (*GroupsApiService) Directory 

func (a *GroupsApiService) Directory(ctx _context.Context, path string) (Directory, *_nethttp.Response, error)

Directory Retrieve an existing Directory from the groups hierarchy Retrieve an existing directory from the groups hierarchy.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param path The path of a directory in the directory tree

@return Directory

func (*GroupsApiService) DirectoryMembers 

func (a *GroupsApiService) DirectoryMembers(ctx _context.Context, path string, localVarOptionals *DirectoryMembersOpts) ([]Device, *_nethttp.Response, error)

DirectoryMembers Retrieve a list of Members Retrieve a list of members(Gateways or Devices) that match the given filter.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param path The path of a directory in the directory tree
  • @param optional nil or *DirectoryMembersOpts - Optional Parameters:
  • @param "Devices" (optional.Bool) - If the value is <b>true</b>, the members are devices, if it is <b>false</b>, the members are gateways.
  • @param "Recursive" (optional.Bool) - If the value is <b>true</b>, all members will be listed (including sub-directories' gateways or devices), if <b>false</b>, only members directly under this directory will be listed.
  • @param "Filter" (optional.String) - <h4>Filter operations:</h4><ui><li><tt>eq({property},{value})</tt></li><li><tt>ne({property},{value})</tt></li><li><tt>gt({property},{value})</tt></li><li><tt>ge({property},{value})</tt></li><li><tt>lt({property},{value})</tt></li><li><tt>le({property},{value})</tt></li><li><tt>in({property},{value},{value},...)</tt></li><li><tt>like({property},{value})</tt></li><li><tt>exists({property})</tt></li></ui>Note: When using filter operations, only devices with the specified properties are returned. For example, the filter ne(attributes/owner, \"SID123\") will only return devices that do have the owner attribute.<h4>Logical operations:</h4><ui><li><tt>and({query},{query},...)</tt></li><li><tt>or({query},{query},...)</tt></li><li><tt>not({query})</tt></li></ui><h5>Examples:</h5><ui><li><tt>eq(attributes/{attributeId},\"value\")</tt></li><li><tt>exists(features/{featureId}/properties/{category}/{propertyId}, value)</tt></li><li><tt>and(eq(attributes/{attributeId1},\"value\"),eq(attributes/{attributeId2},\"value\"))</tt></li></ui><b>Filters containing a wildcard * symbol at the beginning can slow down your search request.</b>
  • @param "Namespaces" (optional.String) - A comma separated list of namespaces. This list is used to limit the query to things in the given namespaces only. If this parameter is omitted, all registered namespaces of your solution will be queried.<h4>Examples:</h4><ul><li><tt>?namespaces=com.example.namespace</tt></li><li><tt>?namespaces=com.example.namespace1,com.example.namespace2</tt></li><li><tt>?fields=deviceId,attributes/location/longitude,attributes/address(city,street)</tt></li></ul>
  • @param "Option" (optional.String) - <p>Possible parameter values:</p><h5>Sort operations</h5><ul><li><tt>sort([+|-]{property})</tt></li><li><tt>sort([+|-]{property},[+|-]{property},...)</tt></li></ul><p><h5>Paging operations</h5><ul><li><tt>size({page-size}) Maximum allowed page size is 200. Default page size is 25.</tt></li><li><tt>cursor({cursor-id}) Start the search from the cursor location. Specify the cursor ID without quotation marks. Cursor IDs are given in search responses and mark the position after the last entry of the previous search. The meaning of cursor IDs is unspecified and may change without notice.</tt></li></ul><p><h4>Examples:</h4><ul><li><tt>sort(+id)</tt></li><li><tt>sort(-attributes/{attributePropertyValue})</tt></li><li><tt>size(10) return 10 results</tt></li><li><tt>cursor(LOREMIPSUM) return results after the position of the cursor LOREMIPSUM.</tt></li></ul><p><h5><b>Combine:</b></h5><p>If you need to specify multiple options, when using the swagger UI just write each option in a new line. When using the plain REST API programmatically, you will need to separate the options using a comma (,) character. size(200),cursor(LOREMIPSUM).
  • @param "Fields" (optional.String) - Contains a comma separated list of fields to be included in the returned JSON. Attributes can be selected in the same manner.<br><p><b>Selectable fields</b></p><ul><li><tt>ID</tt></li> <li><tt>policyId</tt></li><li><tt>attributes</tt><p>Supports selecting arbitrary sub-fields by using a comma separated list:</p><ul><li>several attribute paths can be passed as a comma separated list of JSON pointers (RFC-6901)<br><br><b>For example:</b><br><ul><li><tt>?fields=attributes/{attributeId}/{attributeValue}</tt> would select only attribute value (if present)</li><li><tt>?fields=attributes/{attributeId1}/{attributeValue},attributes/{attributeId2}/{attributeValue}</tt></li><li><tt>?fields=attributes/{attributeId1}/{attributeValue1},attributes/{attributeId1}/{attributeValue2}</tt></li></ul></li><li>a comma-separated list of sub-fields (a sub-field is a JSON pointer (RFC-6901) separated with /) to select </li><li>sub-selectors can be used to request only specific sub-fields by placing expressions in parentheses ( ) after a selected subfield<br><b>For example:</b><br><ul><li><tt>?fields=attributes/{attributeId}/(attributeValue1,attributeValue2)</tt></li></ul></li></ul></li><li><tt>features</tt><p>Supports selecting arbitrary fields in features similar to attributes</p><b>features/{featureId}/properties/{category}/{propertyId}</b></li></ul><h4>Examples:</h4><ul><li><tt>?fields=id,attributes,features</tt></li><li><tt>?fields=attributes/{attributeId1}(attributeValue1,attributeValue1),features</tt></li><li><tt>?fields=id,attributes/{attributeId1},features/{featureId}/properties/{category}/{propertyId}</tt></li></ul>

@return []Device

func (*GroupsApiService) ListAttributes1 

func (a *GroupsApiService) ListAttributes1(ctx _context.Context, path string) ([]Attribute, *_nethttp.Response, error)

ListAttributes1 List all Attributes of a specific Directory The Attributes of the specific Directory were successfully retrieved.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param path

@return []Attribute

func (*GroupsApiService) ListTagAttributes 

func (a *GroupsApiService) ListTagAttributes(ctx _context.Context, name string) ([]Attribute, *_nethttp.Response, error)

ListTagAttributes List all Attributes of a specific Tag The Attributes of the specific Tag were successfully retrieved.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name

@return []Attribute

func (*GroupsApiService) MembersTag 

func (a *GroupsApiService) MembersTag(ctx _context.Context, name string, localVarOptionals *MembersTagOpts) ([]Device, *_nethttp.Response, error)

MembersTag Retrieve a list of Members Retrieve a list of members(Gateways or Devices) that match the given filter.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name The name of the tag
  • @param optional nil or *MembersTagOpts - Optional Parameters:
  • @param "Devices" (optional.Bool) - If the value is <b>true</b>, the members are devices, if it is <b>false</b>, the members are gateways.
  • @param "Filter" (optional.String) -
  • @param "Namespaces" (optional.String) -
  • @param "Option" (optional.String) -
  • @param "Fields" (optional.String) - Contains a comma separated list of fields to be included in the returned JSON. Attributes can be selected in the same manner.<br><p><b>Selectable fields</b></p><ul><li><tt>ID</tt></li> <li><tt>policyId</tt></li><li><tt>attributes</tt><p>Supports selecting arbitrary sub-fields by using a comma separated list:</p><ul><li>several attribute paths can be passed as a comma separated list of JSON pointers (RFC-6901)<br><br><b>For example:</b><br><ul><li><tt>?fields=attributes/{attributeId}/{attributeValue}</tt> would select only attribute value (if present)</li><li><tt>?fields=attributes/{attributeId1}/{attributeValue},attributes/{attributeId2}/{attributeValue}</tt></li><li><tt>?fields=attributes/{attributeId1}/{attributeValue1},attributes/{attributeId1}/{attributeValue2}</tt></li></ul></li><li>a comma-separated list of sub-fields (a sub-field is a JSON pointer (RFC-6901) separated with /) to select </li><li>sub-selectors can be used to request only specific sub-fields by placing expressions in parentheses ( ) after a selected subfield<br><b>For example:</b><br><ul><li><tt>?fields=attributes/{attributeId}/(attributeValue1,attributeValue2)</tt></li></ul></li></ul></li><li><tt>features</tt><p>Supports selecting arbitrary fields in features similar to attributes</p><b>features/{featureId}/properties/{category}/{propertyId}</b></li></ul><h4>Examples:</h4><ul><li><tt>?fields=id,attributes,features</tt></li><li><tt>?fields=attributes/{attributeId1}(attributeValue1,attributeValue1),features</tt></li><li><tt>?fields=id,attributes/{attributeId1},features/{featureId}/properties/{category}/{propertyId}</tt></li></ul>

@return []Device

func (*GroupsApiService) MoveDirectory 

func (a *GroupsApiService) MoveDirectory(ctx _context.Context, path string, targetParentPath string) (*_nethttp.Response, error)

MoveDirectory Move the Directory Moves the directory with a specific identifier to a target directory with the specified identifier.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param path The path of a directory in the directory tree
  • @param targetParentPath The path of the parent directory, the directory will be moved to

func (*GroupsApiService) MoveMember 

func (a *GroupsApiService) MoveMember(ctx _context.Context, path string, memberId string) (*_nethttp.Response, error)

MoveMember Move the Device or Gateway to the target directory Move a Device or Gateway with a specific ID to the target directory with the specified ID.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param path The path of the parent directory, the device will be moved to
  • @param memberId

func (*GroupsApiService) Parent 

func (a *GroupsApiService) Parent(ctx _context.Context, path string) (Directory, *_nethttp.Response, error)

Parent Retrieve the parent directory of this directory Retrieve the parent directory of this directory

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param path The path of a directory in the directory tree

@return Directory

func (*GroupsApiService) Root 

func (a *GroupsApiService) Root(ctx _context.Context) (Directory, *_nethttp.Response, error)

Root Retrieve the Root Directory of the directory hierarchy Retrieve the root directory of the directory hierarchy. All directories, that have no parent directory assigned, are subdirectories of this directory.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return Directory

func (*GroupsApiService) SetAttribute1 

func (a *GroupsApiService) SetAttribute1(ctx _context.Context, path string, localVarOptionals *SetAttribute1Opts) (Directory, *_nethttp.Response, error)

SetAttribute1 Add Attribute of a specific Directory Add Attribute of the specific Directory. If an attribute with the same path already exists it will be overwritten.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param path
  • @param optional nil or *SetAttribute1Opts - Optional Parameters:
  • @param "Attribute" (optional.Interface of Attribute) - Attribute

@return Directory

func (*GroupsApiService) SetTagAttribute 

func (a *GroupsApiService) SetTagAttribute(ctx _context.Context, name string, localVarOptionals *SetTagAttributeOpts) (Directory, *_nethttp.Response, error)

SetTagAttribute Add Attribute of a specific Tag Add Attribute of the specific Tag. If an attribute with the same path already exists it will be overwritten.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name
  • @param optional nil or *SetTagAttributeOpts - Optional Parameters:
  • @param "Attribute" (optional.Interface of Attribute) - Attribute

@return Directory

func (*GroupsApiService) Tag 

func (a *GroupsApiService) Tag(ctx _context.Context, name string) (Tag, *_nethttp.Response, error)

Tag Retrieve an existing Tag with a specified name Retrieve an existing Tag with a specified name

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name The name of the tag

@return Tag

func (*GroupsApiService) TagAttribute 

func (a *GroupsApiService) TagAttribute(ctx _context.Context, name string, attributePath string) (Attribute, *_nethttp.Response, error)

TagAttribute Retrieve a specific Attribute of a specific Tag Retrieve a specific Attribute of the Tag, identified by name. The Attribute (JSON) can be referenced hierarchically by applying a JSON Pointer notation (RFC-6901), e.g.: /tags/{name}/attributes/house/room in order to retrieve the house field of an room object.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name
  • @param attributePath

@return Attribute

func (*GroupsApiService) TagMember 

func (a *GroupsApiService) TagMember(ctx _context.Context, name string, memberId string, localVarOptionals *TagMemberOpts) (*_nethttp.Response, error)

TagMember Tag/Untag a Member of a Tag Tag/Untag a member with a specific ID i.e. attach/detach the tag with the specified ID from the member(gateway or device).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name The name of the tag
  • @param memberId The memberId(of a device or gateway)
  • @param optional nil or *TagMemberOpts - Optional Parameters:
  • @param "Tag" (optional.Bool) - If the value is <b>true</b>, attaches the tag with the specified ID to the device, if <b>false</b>, detaches the tag with the specified ID from the device.

func (*GroupsApiService) Tags 

func (a *GroupsApiService) Tags(ctx _context.Context, localVarOptionals *TagsOpts) ([]Tag, *_nethttp.Response, error)

Tags Retrieve a list of Tags matching the specified filter Retrieve a list of Tags matching the specified filter

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *TagsOpts - Optional Parameters:
  • @param "Filter" (optional.String) -
  • @param "Option" (optional.String) -

@return []Tag

type IdSelectionInfo 

type IdSelectionInfo struct {
	// Ids of the devices belonging to this selection
	DeviceIds []string `json:"deviceIds"`
}

IdSelectionInfo A Selection composed of a list of device ids.

type Identifier 

type Identifier struct {
	// Unique entity namespace
	Namespace string `json:"namespace"`
	// Entity id
	Id string `json:"id"`
}

Identifier Unique entity identifier

type LaunchTaskOpts 

type LaunchTaskOpts struct {
	RestTaskInfo optional.Interface
}

LaunchTaskOpts Optional parameters for the method 'LaunchTask'

type ListDevicesForRuleOpts 

type ListDevicesForRuleOpts struct {
	StateFilter optional.String
	Option      optional.String
}

ListDevicesForRuleOpts Optional parameters for the method 'ListDevicesForRule'

type ListDevicesForTaskOpts 

type ListDevicesForTaskOpts struct {
	StateFilter optional.String
	Option      optional.String
}

ListDevicesForTaskOpts Optional parameters for the method 'ListDevicesForTask'

type ListExecutionsForDeviceOpts 

type ListExecutionsForDeviceOpts struct {
	StateFilter optional.String
	Option      optional.String
}

ListExecutionsForDeviceOpts Optional parameters for the method 'ListExecutionsForDevice'

type ListRulesForDeviceOpts 

type ListRulesForDeviceOpts struct {
	StateFilter optional.String
	Option      optional.String
}

ListRulesForDeviceOpts Optional parameters for the method 'ListRulesForDevice'

type ListTasksForDeviceInRuleOpts 

type ListTasksForDeviceInRuleOpts struct {
	StateFilter optional.String
	Option      optional.String
}

ListTasksForDeviceInRuleOpts Optional parameters for the method 'ListTasksForDeviceInRule'

type ListTasksForDeviceOpts 

type ListTasksForDeviceOpts struct {
	StateFilter optional.String
	FreeTasks   optional.Bool
	Option      optional.String
}

ListTasksForDeviceOpts Optional parameters for the method 'ListTasksForDevice'

type MembersTagOpts 

type MembersTagOpts struct {
	Devices    optional.Bool
	Filter     optional.String
	Namespaces optional.String
	Option     optional.String
	Fields     optional.String
}

MembersTagOpts Optional parameters for the method 'MembersTag'

type ModelEvent 

type ModelEvent struct {
	Name       string          `json:"name,omitempty"`
	Properties []ModelProperty `json:"properties,omitempty"`
}

ModelEvent struct for ModelEvent

type ModelId 

type ModelId struct {
	Name      string `json:"name,omitempty"`
	Namespace string `json:"namespace,omitempty"`
	Version   string `json:"version,omitempty"`
}

ModelId struct for ModelId

type ModelProperty 

type ModelProperty struct {
	Mandatory   bool                   `json:"mandatory,omitempty"`
	Name        string                 `json:"name,omitempty"`
	Description string                 `json:"description,omitempty"`
	Type        map[string]interface{} `json:"type,omitempty"`
	Constraints []Constraint           `json:"constraints,omitempty"`
	Multiple    bool                   `json:"multiple,omitempty"`
}

ModelProperty struct for ModelProperty

type ModifyOpts 

type ModifyOpts struct {
	RuleInfo optional.Interface
}

ModifyOpts Optional parameters for the method 'Modify'

type Operation 

type Operation struct {
	Name        string     `json:"name,omitempty"`
	Description string     `json:"description,omitempty"`
	Result      ReturnType `json:"result,omitempty"`
	Params      []Param    `json:"params,omitempty"`
	Breakable   bool       `json:"breakable,omitempty"`
}

Operation struct for Operation

type Param 

type Param struct {
	Mandatory   bool                   `json:"mandatory,omitempty"`
	Name        string                 `json:"name,omitempty"`
	Description string                 `json:"description,omitempty"`
	Type        map[string]interface{} `json:"type,omitempty"`
	Constraints []Constraint           `json:"constraints,omitempty"`
	Multiple    bool                   `json:"multiple,omitempty"`
}

Param struct for Param

type Parameters 

type Parameters struct {
	Identifier Identifier        `json:"identifier,omitempty"`
	Attributes []AttributeObject `json:"attributes,omitempty"`
	// User-friendly name
	Name string `json:"name"`
}

Parameters struct for Parameters

type Properties 

type Properties struct {
	Append     bool                              `json:"append,omitempty"`
	Properties map[string]map[string]interface{} `json:"properties,omitempty"`
}

Properties struct for Properties

type Property 

type Property struct {
	// Property identifier
	Id string `json:"id"`
	// Property category, e.g. status, configuration, etc
	Category string `json:"category,omitempty"`
	// Property value
	Value map[string]interface{} `json:"value"`
}

Property struct for Property

type PropertyObject 

type PropertyObject struct {
	// Property identifier
	Id string `json:"id"`
	// Property category, e.g. status, configuration, etc
	Category string `json:"category,omitempty"`
	// Property value
	Value map[string]interface{} `json:"value"`
}

PropertyObject Feature properties

type RegisterInfo 

type RegisterInfo struct {
	Credentials Credentials `json:"credentials,omitempty"`
	// Directory path
	DirectoryPath string `json:"directoryPath,omitempty"`
	// Attribute values
	Attributes []AttributeObject `json:"attributes,omitempty"`
}

RegisterInfo struct for RegisterInfo

type RegisterOpts 

type RegisterOpts struct {
	RegisterInfo optional.Interface
}

RegisterOpts Optional parameters for the method 'Register'

type RestTaskInfo 

type RestTaskInfo struct {
	// User-friendly display name of this Task
	DisplayName string          `json:"displayName,omitempty"`
	Action      ActionInfo      `json:"action,omitempty"`
	ScopeInfo   ScopeInfo       `json:"scopeInfo,omitempty"`
	OptInfo     TaskExecOptInfo `json:"optInfo,omitempty"`
}

RestTaskInfo struct for RestTaskInfo

type ReturnType 

type ReturnType struct {
	Type      map[string]interface{} `json:"type,omitempty"`
	Multiple  bool                   `json:"multiple,omitempty"`
	Primitive bool                   `json:"primitive,omitempty"`
}

ReturnType struct for ReturnType

type RuleInfo 

type RuleInfo struct {
	// User-friendly display name of this Rule
	DisplayName string      `json:"displayName"`
	Scope       ScopeInfo   `json:"scope"`
	Trigger     TriggerInfo `json:"trigger,omitempty"`
	Options     ExecOptInfo `json:"options,omitempty"`
	Action      ActionInfo  `json:"action"`
}

RuleInfo struct for RuleInfo

type RuleStatusInfo 

type RuleStatusInfo struct {
	// User-friendly display name of this Rule
	DisplayName string `json:"displayName"`
	// Rule identifier
	RuleId           string `json:"ruleId"`
	State            int32  `json:"state,omitempty"`
	StateDescription string `json:"stateDescription,omitempty"`
	// The count of involved devices with the given execution status.
	InvolvedCount int32 `json:"involvedCount"`
	// The count of involved devices with FINISHED_SUCCESS(0) status.
	SuccessCount int32 `json:"successCount,omitempty"`
	// The count of involved devices with  FINISHED_WARNING(1) status.
	WarningCount int32 `json:"warningCount,omitempty"`
	// The count of involved devices with  FINISHED_ERROR(2) status.
	ErrorCount int32 `json:"errorCount,omitempty"`
	// The count of involved devices with  FINISHED_CANCELED(3) status.
	CancelCount     int32 `json:"cancelCount,omitempty"`
	TriggersCount   int32 `json:"triggersCount,omitempty"`
	NextTimeTrigger int64 `json:"nextTimeTrigger,omitempty"`
	// User
	User string `json:"user,omitempty"`
	// Custom properties assigned to this Rule.
	Props      []string    `json:"props,omitempty"`
	Scope      ScopeInfo   `json:"scope"`
	Trigger    TriggerInfo `json:"trigger,omitempty"`
	Options    ExecOptInfo `json:"options,omitempty"`
	Action     ActionInfo  `json:"action"`
	FullStatus bool        `json:"fullStatus,omitempty"`
}

RuleStatusInfo struct for RuleStatusInfo

type RulesApiService 

type RulesApiService service

RulesApiService RulesApi service

func (*RulesApiService) Action 

func (a *RulesApiService) Action(ctx _context.Context, ruleId string) (*_nethttp.Response, error)

Action Retrieve the Rule action Retrieve the Groovy script defining the action for this Rule.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ruleId

func (*RulesApiService) CreateRule 

func (a *RulesApiService) CreateRule(ctx _context.Context, localVarOptionals *CreateRuleOpts) (RuleStatusInfo, *_nethttp.Response, error)

CreateRule Create a Rule Create a Rule with the specified attributes - &lt;code&gt;displayName&lt;/code&gt;, &lt;code&gt;scope&lt;/code&gt;, &lt;code&gt;trigger&lt;/code&gt;, &lt;code&gt;options&lt;/code&gt;, and &lt;code&gt;action&lt;/code&gt;. The &lt;code&gt;displayName&lt;/code&gt;, &lt;code&gt;scope&lt;/code&gt;, &lt;code&gt;trigger&lt;/code&gt;, and &lt;code&gt;action&lt;/code&gt; are required.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *CreateRuleOpts - Optional Parameters:
  • @param "RuleInfo" (optional.Interface of RuleInfo) - Creates new rule

@return RuleStatusInfo

func (*RulesApiService) DeleteRule 

func (a *RulesApiService) DeleteRule(ctx _context.Context, ruleId string) (*_nethttp.Response, error)

DeleteRule Delete the Rule Delete the Rule with the specified &lt;code&gt;ruleId&lt;/code&gt;. If the Rule could not be found or requester has insufficient permissions to access it, а &lt;code&gt;204 No Content &lt;/code&gt;will be returned.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ruleId

func (*RulesApiService) EventMetadata 

func (a *RulesApiService) EventMetadata(ctx _context.Context, triggerType string) (*_nethttp.Response, error)

EventMetadata Retrieve a JSON schema of all possible events Retrieve a JSON schema describing a tree-structured collection of all possible events delivered by this Trigger type.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param triggerType

func (*RulesApiService) Fire 

func (a *RulesApiService) Fire(ctx _context.Context, ruleId string) (*_nethttp.Response, error)

Fire Fire the Rule manually Fire the Rule with the specified &lt;code&gt;ruleId&lt;/code&gt; manually.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ruleId

func (*RulesApiService) GetActionDefMetada 

func (a *RulesApiService) GetActionDefMetada(ctx _context.Context, actionType string) (*_nethttp.Response, error)

GetActionDefMetada Retrieve metadata in JSON schema format Retrieve JSON schema format metadata specified by the given &lt;code&gt;actionType&lt;/code&gt;, describing the input needed on Rule activation.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param actionType

func (*RulesApiService) GetActionTypes 

func (a *RulesApiService) GetActionTypes(ctx _context.Context) (*_nethttp.Response, error)

GetActionTypes Retrieve all available registered Action types Retrieve all available registered Action provider types. Groovy Script action type is available by default.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*RulesApiService) ListDevicesForRule 

func (a *RulesApiService) ListDevicesForRule(ctx _context.Context, ruleId string, localVarOptionals *ListDevicesForRuleOpts) (*_nethttp.Response, error)

ListDevicesForRule Retrieve a list of all involved Devices Retrieve a list of all Devices which are involved in this Rule and satisfy the applied &lt;code&gt;stateFilter&lt;/code&gt;. A Device is considered involved in the Rule if it is involved in at least one Task launched by that Rule.&lt;p&gt; &lt;h4&gt;Available stateFilter values:&lt;/h4&gt; &lt;ui&gt;&lt;li&gt;&lt;tt&gt; FINISHED_SUCCESS(0) : Retrieve only Devices that have finished with a success state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; FINISHED_WARNING(1) : Retrieve only Devices that have finished the execution with a warning state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; FINISHED_ERROR(2) : Retrieve only Devices that have finished the execution with an error state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; FINISHED_CANCELED(3) : Retrieve only devices that have finished the execution with a canceled state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; RUNNING(4) : Retrieve only Devices that have a running state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt;FINISHED(64): This value unites all FINISHED_xxx values and could be used only as a parameter for filtering&lt;/tt&gt;&lt;/li&gt;&lt;li&gt;&lt;tt&gt;ANY(128): Retrieve all involved devices, regardless of the completion state

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ruleId
  • @param optional nil or *ListDevicesForRuleOpts - Optional Parameters:
  • @param "StateFilter" (optional.String) -
  • @param "Option" (optional.String) - <p>Possible values for the parameter:</p><h5>Paging operations</h5><ul><li><tt>size({page-size}) Maximum allowed page size is 200. Default page size is 25</tt></li><li><tt>cursor({cursor-id}) Start the search from the cursor location. Specify the cursor ID without quotation marks. Cursor IDs are given in search responses and mark the position after the last entry of the previous search. The meaning of cursor IDs is unspecified and may change without notice.</tt></li></ul><p><h4>Examples:</h4><ul><li><tt>size(10) return 10 results</tt></li><li><tt>cursor(LOREMIPSUM) return results after the position of the cursor LOREMIPSUM.</tt></li></ul><p><h5><b>Combine:</b></h5><p>If you need to specify multiple options, when using the swagger UI just write each option in a new line. When using the plain REST API programmatically, you will need to separate the options using a comma (,) character. size(200),cursor(LOREMIPSUM)

func (*RulesApiService) ListRulesForDevice 

func (a *RulesApiService) ListRulesForDevice(ctx _context.Context, deviceId string, localVarOptionals *ListRulesForDeviceOpts) (*_nethttp.Response, error)

ListRulesForDevice Retrieve all Rules involving a particular Device Retrieve all Rules involving a particular Device in which the latter satisfies the applied state filter.&lt;p&gt; &lt;h4&gt;Available stateFilter values:&lt;/h4&gt; &lt;ui&gt;&lt;li&gt;&lt;tt&gt; FINISHED_SUCCESS(0) : Retrieve only Devices that have finished with a success state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; FINISHED_WARNING(1) : Retrieve only Devices that have finished the execution with a warning state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; FINISHED_ERROR(2) : Retrieve only Devices that have finished the execution with an error state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; FINISHED_CANCELED(3) : Retrieve only devices that have finished the execution with a canceled state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; RUNNING(4) : Retrieve only Devices that have a running state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt;FINISHED(64): This value unites all FINISHED_xxx values and could be used only as a parameter for filtering&lt;/tt&gt;&lt;/li&gt;&lt;li&gt;&lt;tt&gt;ANY(128): Retrieve all involved devices, regardless of the completion state

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId
  • @param optional nil or *ListRulesForDeviceOpts - Optional Parameters:
  • @param "StateFilter" (optional.String) -
  • @param "Option" (optional.String) - <p>Possible values for the parameter:</p><h5>Paging operations</h5><ul><li><tt>size({page-size}) Maximum allowed page size is 200. Default page size is 25</tt></li><li><tt>cursor({cursor-id}) Start the search from the cursor location. Specify the cursor ID without quotation marks. Cursor IDs are given in search responses and mark the position after the last entry of the previous search. The meaning of cursor IDs is unspecified and may change without notice.</tt></li></ul><p><h4>Examples:</h4><ul><li><tt>size(10) return 10 results</tt></li><li><tt>cursor(LOREMIPSUM) return results after the position of the cursor LOREMIPSUM.</tt></li></ul><p><h5><b>Combine:</b></h5><p>If you need to specify multiple options, when using the swagger UI just write each option in a new line. When using the plain REST API programmatically, you will need to separate the options using a comma (,) character. size(200),cursor(LOREMIPSUM)

func (*RulesApiService) ListTasksForDeviceInRule 

func (a *RulesApiService) ListTasksForDeviceInRule(ctx _context.Context, ruleId string, deviceId string, localVarOptionals *ListTasksForDeviceInRuleOpts) (*_nethttp.Response, error)

ListTasksForDeviceInRule Retrieve all Tasks launched by the Rule which involve a specified Device Retrieve all Tasks launched by the Rule which involve a specified Device. Limited amount of data is retrieved, by default on a page with 20 elements.&lt;p&gt; &lt;h4&gt;Available stateFilter values:&lt;/h4&gt; &lt;ui&gt;&lt;li&gt;&lt;tt&gt; FINISHED_SUCCESS(0) : Retrieve only Devices that have finished with a success state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; FINISHED_WARNING(1) : Retrieve only Devices that have finished the execution with a warning state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; FINISHED_ERROR(2) : Retrieve only Devices that have finished the execution with an error state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; FINISHED_CANCELED(3) : Retrieve only devices that have finished the execution with a canceled state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; RUNNING(4) : Retrieve only Devices that have a running state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt;FINISHED(64): This value unites all FINISHED_xxx values and could be used only as a parameter for filtering&lt;/tt&gt;&lt;/li&gt;&lt;li&gt;&lt;tt&gt;ANY(128): Retrieve all involved devices, regardless of the completion state

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ruleId
  • @param deviceId
  • @param optional nil or *ListTasksForDeviceInRuleOpts - Optional Parameters:
  • @param "StateFilter" (optional.String) -
  • @param "Option" (optional.String) - <p>Possible values for the parameter:</p><h5>Paging operations</h5><ul><li><tt>size({page-size}) Maximum allowed page size is 200. Default page size is 25</tt></li><li><tt>cursor({cursor-id}) Start the search from the cursor location. Specify the cursor ID without quotation marks. Cursor IDs are given in search responses and mark the position after the last entry of the previous search. The meaning of cursor IDs is unspecified and may change without notice.</tt></li></ul><p><h4>Examples:</h4><ul><li><tt>size(10) return 10 results</tt></li><li><tt>cursor(LOREMIPSUM) return results after the position of the cursor LOREMIPSUM.</tt></li></ul><p><h5><b>Combine:</b></h5><p>If you need to specify multiple options, when using the swagger UI just write each option in a new line. When using the plain REST API programmatically, you will need to separate the options using a comma (,) character. size(200),cursor(LOREMIPSUM)

func (*RulesApiService) Modify 

func (a *RulesApiService) Modify(ctx _context.Context, ruleId string, localVarOptionals *ModifyOpts) (*_nethttp.Response, error)

Modify Modify an existing Rule Modify an existing Rule. Only Rules whose state is not enabled can be modified. After a Rule is modified, any information related to its previous execution (e.g. launched Tasks, number of involved, finished Devices, etc.) will be cleared.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ruleId
  • @param optional nil or *ModifyOpts - Optional Parameters:
  • @param "RuleInfo" (optional.Interface of RuleInfo) - Modifies the Rule

func (*RulesApiService) Options 

func (a *RulesApiService) Options(ctx _context.Context, ruleId string) (*_nethttp.Response, error)

Options Retrieve the Rule execution options Retrieve the execution options of the Rule with the specified &lt;code&gt;ruleId&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ruleId

func (*RulesApiService) Properties 

func (a *RulesApiService) Properties(ctx _context.Context, ruleId string) (*_nethttp.Response, error)

Properties Get the custom Rule properties Get the custom properties of the Rule with the specified &lt;code&gt;ruleId&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ruleId

func (*RulesApiService) RetryDevice 

func (a *RulesApiService) RetryDevice(ctx _context.Context, ruleId string, deviceId string) (*_nethttp.Response, error)

RetryDevice Retry the Rule over the Device Retry the Rule over the Device with the specified &lt;code&gt;deviceId&lt;/code&gt;. &#39;Once Per Device&#39; option must be selected for the Rule.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ruleId
  • @param deviceId

func (*RulesApiService) RetryDevices 

func (a *RulesApiService) RetryDevices(ctx _context.Context, ruleId string, stateFilter []string) (*_nethttp.Response, error)

RetryDevices Retry the Rule over the Devices whose state satisfies the applied stateFilter Retry the Rule over the Devices whose state satisfies the applied &lt;code&gt;stateFilter&lt;/code&gt;. &#39;Once Per Device&#39; option must be selected for the Rule.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ruleId
  • @param stateFilter

func (*RulesApiService) Rule 

func (a *RulesApiService) Rule(ctx _context.Context, ruleId string, statistic bool) (RuleStatusInfo, *_nethttp.Response, error)

Rule Retrieve a Rule Retrieve a Rule by a specified &lt;code&gt;ruleId&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ruleId
  • @param statistic Load statistic

@return RuleStatusInfo

func (*RulesApiService) RuleDevice 

func (a *RulesApiService) RuleDevice(ctx _context.Context, ruleId string, deviceId string) (*_nethttp.Response, error)

RuleDevice Retrieve the execution status of a specified Device within the Rule Retrieve the execution status of a specified Device within the Rule.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ruleId
  • @param deviceId

func (*RulesApiService) Rules 

func (a *RulesApiService) Rules(ctx _context.Context, localVarOptionals *RulesOpts) (*_nethttp.Response, error)

Rules Retrieve all available Rules 

Retrieve all available Rules that satisfy the specified filtering criteria.
* @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param optional nil or *RulesOpts - Optional Parameters:
* @param "Filter" (optional.String) -  An RQL filter over the Rule attributes.<h5></tt><br/>The attribute names in the filtering conditions can be some of:</h5> <ui><tt><li/><b>state</b> - integer value corresponding to the Rule state as follows: </tt> <br/> <tt>0 - DEFINED </tt> <br/><tt>1 - ENABLED </tt><br/><tt> 2 - DISABLED</tt> <br/><tt>3 - FAILED_TO_ENABLE</tt> <li/><tt><b>stateDescription</b> - string value corresponding to the state description. </tt><li/><tt><b> involvedCount</b> - integer value corresponding to the the number of involved Devices in the Rule.</tt> <li/><tt><b> successCount</b> - integer value corresponding to the the number of successfully finished Devices in the Rule.</tt><li/><tt><b>warningCount</b> - integer value corresponding to the the number of Devices finished with warning in the Rule. </tt><li/><tt><b> errorCount</b> - integer value corresponding the the number of Devices finished with error in the Rule.</tt> <li/><tt><b>cancelCount</b> - integer value corresponding to the the number of Devices finished with warning in the Rule.</tt><li/><tt><b>nextTimeTrigger</b> - corresponds to the next trigger time (in milliseconds since 1 Jan 1970) if the Rule has a timer trigger.</tt> <li/><tt><b>ruleId</b> - string value corresponding to the Rule id. </tt><li/><tt><b>user</b> - string value corresponding to the user name of the user that has created the Rule.<li/> <tt><b>displayName</b> - string value corresponding to the Rule display name. </tt><h4>Filter operations:</h4><ui><li><tt>eq({property},{value})</tt></li><li><tt>ne({property},{value})</tt></li><li><tt>gt({property},{value})</tt></li><li><tt>ge({property},{value})</tt></li><li><tt>lt({property},{value})</tt></li><li><tt>le({property},{value})</tt></li><li><tt>in({property},{value},{value},...)</tt></li><li><tt>like({property},{value})</tt></li><li><tt>exists({property})</tt></li></ui>Note: When using filter operations, only Rules with the specified properties are returned.<h4>Logical operations:</h4><ui><li><tt>and({query},{query},...)</tt></li><li><tt>or({query},{query},...)</tt></li><li><tt>not({query})</tt></li></ui><h5>Examples:</h5><ui><li><tt>eq(state,0)</tt></li><li><tt>and(eq(involvedCount,2),eq(state,0))</tt></li></ui>
* @param "Option" (optional.String) -  <p>Possible values for the parameter:</p><h5>Paging operations</h5><ul><li><tt>size({page-size}) Maximum allowed page size is 200. Default page size is 25</tt></li><li><tt>cursor({cursor-id}) Start the search from the cursor location. Specify the cursor ID without quotation marks. Cursor IDs are given in search responses and mark the position after the last entry of the previous search. The meaning of cursor IDs is unspecified and may change without notice.</tt></li></ul><p><h4>Examples:</h4><ul><li><tt>size(10) return 10 results</tt></li><li><tt>cursor(LOREMIPSUM) return results after the position of the cursor LOREMIPSUM.</tt></li></ul><p><h5><b>Combine:</b></h5><p>If you need to specify multiple options, when using the swagger UI just write each option in a new line. When using the plain REST API programmatically, you will need to separate the options using a comma (,) character. size(200),cursor(LOREMIPSUM)

func (*RulesApiService) Scope 

func (a *RulesApiService) Scope(ctx _context.Context, ruleId string) (*_nethttp.Response, error)

Scope Retrieve the Rule scope Retrieve the scope of an existing Rule identified by the specified &lt;code&gt;ruleId&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ruleId

func (*RulesApiService) SetProperties 

func (a *RulesApiService) SetProperties(ctx _context.Context, ruleId string, localVarOptionals *SetPropertiesOpts) (*_nethttp.Response, error)

SetProperties Set custom Rule properties Set custom properties of the Rule with the specified &lt;code&gt;ruleId&lt;/code&gt;. If &lt;tt&gt; append &lt;/tt&gt; is &lt;tt&gt; true&lt;/tt&gt; the supplied properties will be appended/added to any properties currently existing for this Rule, otherwise any existing properties will be fully replaced by the newly set ones.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ruleId
  • @param optional nil or *SetPropertiesOpts - Optional Parameters:
  • @param "Properties" (optional.Interface of Properties) - Set or add rule properties

func (*RulesApiService) SetState 

func (a *RulesApiService) SetState(ctx _context.Context, ruleId string, localVarOptionals *SetStateOpts) (*_nethttp.Response, error)

SetState Enable or disable the Rule Enable or disable the Rule with the specified &lt;code&gt;ruleId&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ruleId
  • @param optional nil or *SetStateOpts - Optional Parameters:
  • @param "State" (optional.String) -

func (*RulesApiService) State 

func (a *RulesApiService) State(ctx _context.Context, ruleId string) (string, *_nethttp.Response, error)

State Retrieve the Rule state Retrieve the state of the Rule with the specified &lt;code&gt;ruleId&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ruleId

@return string

func (*RulesApiService) Tasks 

func (a *RulesApiService) Tasks(ctx _context.Context, ruleId string, localVarOptionals *TasksOpts) (*_nethttp.Response, error)

Tasks Retrieve all Tasks launched by the Rule Retrieve all Tasks launched by the Rule. By default, only a limited amount of data is retrieved on a page with 20 elements.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ruleId
  • @param optional nil or *TasksOpts - Optional Parameters:
  • @param "Filter" (optional.String) - An RQL filter over the Task attributes.<h5></tt><br/>The attribute names in the filtering conditions can be some of:</h5> <ui><tt><li/><b>state</b> - integer value corresponding to the Task state as follows: </tt> <br/><br/><tt>1 - RUNNING </tt><br/><tt> 2 - FINISHED</tt> <br/><tt>3 - FAILED_TO_LAUNCH</tt> <li/><tt><b>stateDescription</b> - string value corresponding to the state description </tt><li/><tt><b> involvedCount</b> - integer value corresponding to the the number of involved Devices in the Task.</tt> <li/><tt><b> successCount</b> - integer value corresponding to the the number of successfully finished Devices in the Task</tt><li/><tt><b>warningCount</b> - integer value corresponding the the number of Devices finished with warning in the Task </tt><li/><tt><b> errorCount</b> - integer value corresponding to the the number of Devices finished with error in the Task.</tt> <li/><tt><b>cancelCount</b> - integer value corresponding to the the number of Devices finished with warning in the Task.</tt><li/><tt><b>launchTime</b> - long value corresponding to the Task launch time given as milliseconds since 1 Jan 1970</tt><li/><tt><b>finishTime</b> - long value corresponding to the Task finish time given as milliseconds since 1 Jan 1970</tt><li/><tt><b>isPaused</b> - boolean value that is <code>true</code> when the execution is paused due to time constraint restrictions </tt><li/><tt><b>nextResume</b> - corresponds to resume time (in milliseconds since 1 Jan 1970) if the Task is currently paused </tt><li/><tt><b>nextPause</b> - corresponds to the next pause time (in milliseconds since 1 Jan 1970) if the Task is currently not paused </tt><li/><tt><b>taskId</b> - string value corresponding to the Task id</tt><li/><tt><b>ruleId</b> - string value corresponding to the Rule id if the Task is launched by a Rule trigger</tt><li/><tt><b>user</b> -string value corresponding to the user name of the user that has launched the Task<li/><tt><b>action</b> - string value corresponding to a textual representation of the searched action</tt><li/><tt><b>displayName</b> - string value corresponding the Task display name</tt><h4>Filter operations:</h4><ui><li><tt>eq({property},{value})</tt></li><li><tt>ne({property},{value})</tt></li><li><tt>gt({property},{value})</tt></li><li><tt>ge({property},{value})</tt></li><li><tt>lt({property},{value})</tt></li><li><tt>le({property},{value})</tt></li><li><tt>in({property},{value},{value},...)</tt></li><li><tt>like({property},{value})</tt></li><li><tt>exists({property})</tt></li></ui>Note: When using filter operations, only Tasks with the specified properties are returned.<h4>Logical operations:</h4><ui><li><tt>and({query},{query},...)</tt></li><li><tt>or({query},{query},...)</tt></li><li><tt>not({query})</tt></li></ui><h5>Examples:</h5><ui><li><tt>eq(state,\"0\")</tt></li><li><tt>and(eq(involvedCount,2),eq(state,0))</tt></li></ui>
  • @param "Option" (optional.String) - <p>Possible values for the parameter:</p><h5>Paging operations</h5><ul><li><tt>size({page-size}) Maximum allowed page size is 200. Default page size is 25</tt></li><li><tt>cursor({cursor-id}) Start the search from the cursor location. Specify the cursor ID without quotation marks. Cursor IDs are given in search responses and mark the position after the last entry of the previous search. The meaning of cursor IDs is unspecified and may change without notice.</tt></li></ul><p><h4>Examples:</h4><ul><li><tt>size(10) return 10 results</tt></li><li><tt>cursor(LOREMIPSUM) return results after the position of the cursor LOREMIPSUM.</tt></li></ul><p><h5><b>Combine:</b></h5><p>If you need to specify multiple options, when using the swagger UI just write each option in a new line. When using the plain REST API programmatically, you will need to separate the options using a comma (,) character. size(200),cursor(LOREMIPSUM)

func (*RulesApiService) TriggerMetadata 

func (a *RulesApiService) TriggerMetadata(ctx _context.Context, triggerType string) (*_nethttp.Response, error)

TriggerMetadata Retrieve a JSON schema of the required input Retrieve JSON schema format metadata describing the input required on Rule activation.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param triggerType

func (*RulesApiService) TriggerTypes 

func (a *RulesApiService) TriggerTypes(ctx _context.Context) (*_nethttp.Response, error)

TriggerTypes Retrieve all available registered Trigger types Retrieve all available registered Trigger Provider types.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

type RulesOpts 

type RulesOpts struct {
	Filter optional.String
	Option optional.String
}

RulesOpts Optional parameters for the method 'Rules'

type ScopeInfo 

type ScopeInfo struct {
	// If System-scope the value is <code>true</code>, otherwise <code>false</code>
	SystemScope bool            `json:"systemScope,omitempty"`
	DeviceScope DeviceScopeInfo `json:"deviceScope"`
}

ScopeInfo Scope info, generally divided into System-scope and Device-scope

type ServerConfiguration 

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type SetAttribute1Opts 

type SetAttribute1Opts struct {
	Attribute optional.Interface
}

SetAttribute1Opts Optional parameters for the method 'SetAttribute1'

type SetAttributeOpts 

type SetAttributeOpts struct {
	Attribute optional.Interface
}

SetAttributeOpts Optional parameters for the method 'SetAttribute'

type SetProperties1Opts 

type SetProperties1Opts struct {
	Properties optional.Interface
}

SetProperties1Opts Optional parameters for the method 'SetProperties1'

type SetPropertiesOpts 

type SetPropertiesOpts struct {
	Properties optional.Interface
}

SetPropertiesOpts Optional parameters for the method 'SetProperties'

type SetStateOpts 

type SetStateOpts struct {
	State optional.String
}

SetStateOpts Optional parameters for the method 'SetState'

type SetTagAttributeOpts 

type SetTagAttributeOpts struct {
	Attribute optional.Interface
}

SetTagAttributeOpts Optional parameters for the method 'SetTagAttribute'

type Tag 

type Tag struct {
	Identifier Identifier `json:"identifier"`
	// The attributes that describe this entity
	Attributes []AttributeObject `json:"attributes,omitempty"`
	// The name of this entity
	Name      string                 `json:"name"`
	Attribute map[string]interface{} `json:"attribute,omitempty"`
}

Tag struct for Tag

type TagMemberOpts 

type TagMemberOpts struct {
	Tag optional.Bool
}

TagMemberOpts Optional parameters for the method 'TagMember'

type TagsOpts 

type TagsOpts struct {
	Filter optional.String
	Option optional.String
}

TagsOpts Optional parameters for the method 'Tags'

type TaskExecOptInfo 

type TaskExecOptInfo struct {
	// Restricts the maximum number of devices concurrently executing a Task or Rule.
	ConcurrencyLimit int32 `json:"concurrencyLimit"`
	// Time-schedule is permitted for the Task to act. Time schedule constraint supplied as Cron-expression. <code>Example:</code> <li/>* * 9-17 ? * MON-FRI: defines work time to be on working days (Monday to Friday) between 9.00-17.00h<li/>* * 00-01 * * ?: defines work to be time every day between 00-01 in the morning.<li/>* * * 01 * ?: defines work time to be on the 1st day of each month .
	TimeConstraint string `json:"timeConstraint"`
}

TaskExecOptInfo Execution options define execution behavior of Tasks and Rules

type TaskStatusInfo 

type TaskStatusInfo struct {
	// Task identifier
	TaskId string `json:"taskId,omitempty"`
	// Rule identifier
	RuleId string `json:"ruleId,omitempty"`
	// State of this Task
	State int32 `json:"state"`
	// Description of the Task state.
	StateDescription string `json:"stateDescription"`
	// Task launch time
	LaunchTime int64 `json:"launchTime"`
	// Task finish time
	FinishTime int64 `json:"finishTime"`
	// Count of involved devices with given execution status in this Task.
	InvolvedCount int32 `json:"involvedCount"`
	// Count of involved devices with FINISHED_SUCCESS(0) status
	SuccessCount int32 `json:"successCount,omitempty"`
	// Count of involved devices with FINISHED_WARNING(1) status
	WarningCount int32 `json:"warningCount,omitempty"`
	// Count of involved devices with FINISHED_ERROR(2) status
	ErrorCount int32 `json:"errorCount,omitempty"`
	// Count of involved devices with FINISHED_CANCELED(3) status
	CancelCount int32 `json:"cancelCount,omitempty"`
	IsPaused    bool  `json:"isPaused,omitempty"`
	// Time at which the execution will be resumed.
	NextResume int64 `json:"nextResume,omitempty"`
	// Time at which the execution will be paused.
	NextPause int64 `json:"nextPause,omitempty"`
	// User
	User string `json:"user,omitempty"`
	// Custom properties assigned to this Task.
	Props     []string    `json:"props,omitempty"`
	ScopeInfo ScopeInfo   `json:"scopeInfo"`
	OptInfo   ExecOptInfo `json:"optInfo"`
	Action    ActionInfo  `json:"action"`
	// A User-friendly display name of this Task.
	DisplayName string   `json:"displayName,omitempty"`
	RuleInfo    RuleInfo `json:"ruleInfo,omitempty"`
	//  Task execution is currently paused due to time-constraint restrictions.
	Paused bool `json:"paused,omitempty"`
}

TaskStatusInfo struct for TaskStatusInfo

type Tasks1Opts 

type Tasks1Opts struct {
	Filter optional.String
	Option optional.String
}

Tasks1Opts Optional parameters for the method 'Tasks1'

type TasksApiService 

type TasksApiService service

TasksApiService TasksApi service

func (*TasksApiService) Action1 

func (a *TasksApiService) Action1(ctx _context.Context, taskId string) (*_nethttp.Response, error)

Action1 Retrieve the Task action Retrieve the Groovy script defining the action for this Task.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId

func (*TasksApiService) Cancel 

func (a *TasksApiService) Cancel(ctx _context.Context, taskId string) (*_nethttp.Response, error)

Cancel Cancel the execution of this Task Cancel the execution of the Task by the specified &lt;code&gt;taskId&lt;/code&gt;. If the Task could not be found or requester has insufficient permissions to access it, а &lt;code&gt;204 No Content&lt;/code&gt; will be returned.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId

func (*TasksApiService) CancelDeviceInTask 

func (a *TasksApiService) CancelDeviceInTask(ctx _context.Context, taskId string, deviceId string) (*_nethttp.Response, error)

CancelDeviceInTask Cancel the execution of this Task over a Device Cancel the execution of this Task over a Device

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId
  • @param deviceId

func (*TasksApiService) DeleteTask 

func (a *TasksApiService) DeleteTask(ctx _context.Context, taskId string) (*_nethttp.Response, error)

DeleteTask Delete a Task Delete the Task with the specified &lt;code&gt;taskId&lt;/code&gt;. If the Task could not be found or requester has insufficient permissions to access it, а &lt;code&gt;204 No Content&lt;/code&gt; will be returned.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId

func (*TasksApiService) LaunchTask 

func (a *TasksApiService) LaunchTask(ctx _context.Context, localVarOptionals *LaunchTaskOpts) (TaskStatusInfo, *_nethttp.Response, error)

LaunchTask Launch a Task Launch a Task with the specified attributes - &lt;code&gt;displayName&lt;/code&gt;, &lt;code&gt;scope&lt;/code&gt;, &lt;code&gt;options&lt;/code&gt; and &lt;code&gt;action&lt;/code&gt;. The displayName, scope, and action are required.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *LaunchTaskOpts - Optional Parameters:
  • @param "RestTaskInfo" (optional.Interface of RestTaskInfo) - Launch new task

@return TaskStatusInfo

func (*TasksApiService) ListDevicesForTask 

func (a *TasksApiService) ListDevicesForTask(ctx _context.Context, taskId string, localVarOptionals *ListDevicesForTaskOpts) (*_nethttp.Response, error)

ListDevicesForTask Retrieve all Devices involved in this Task Retrieve all Devices which are involved in this Task and have the specified execution state. The &lt;code&gt;stateFilter&lt;/code&gt; is a filter on the execution state of the retrieved involved devices.&lt;p&gt;&lt;h4&gt;Available stateFilter values:&lt;/h4&gt; &lt;ui&gt;&lt;li&gt;&lt;tt&gt; FINISHED_SUCCESS(0) : Retrieve only Devices that have finished the Task execution with a sucess state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; FINISHED_WARNING(1) : Retrieve only Devices that have finished the Task execution with a warning state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; FINISHED_ERROR(2) : Retrieve only Devices that have finished the Task execution with an error state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; FINISHED_CANCELED(3) : Retrieve only Devices that have finished the Task execution with a canceled state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; RUNNING(4) : Retrieve only Devices that have finished the Task execution with a running state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt;FINISHED(64): This value unites all FINISHED_xxx values and could be used only as parameter for filtering&lt;/tt&gt;&lt;/li&gt;&lt;li&gt;&lt;tt&gt;ANY(128): Retrieve all involved Devices, regardless of the completion sate

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId
  • @param optional nil or *ListDevicesForTaskOpts - Optional Parameters:
  • @param "StateFilter" (optional.String) -
  • @param "Option" (optional.String) - <p>Possible values for the parameter:</p><h5>Paging operations</h5><ul><li><tt>size({page-size}) Maximum allowed page size is 200. Default page size is 25</tt></li><li><tt>cursor({cursor-id}) Start the search from the cursor location. Specify the cursor ID without quotation marks. Cursor IDs are given in search responses and mark the position after the last entry of the previous search. The meaning of cursor IDs is unspecified and may change without notice.</tt></li></ul><p><h4>Examples:</h4><ul><li><tt>size(10) return 10 results</tt></li><li><tt>cursor(LOREMIPSUM) return results after the position of the cursor LOREMIPSUM.</tt></li></ul><p><h5><b>Combine:</b></h5><p>If you need to specify multiple options, when using the swagger UI just write each option in a new line. When using the plain REST API programmatically, you will need to separate the options using a comma (,) character. size(200),cursor(LOREMIPSUM)

func (*TasksApiService) ListExecutionsForDevice 

func (a *TasksApiService) ListExecutionsForDevice(ctx _context.Context, deviceId string, localVarOptionals *ListExecutionsForDeviceOpts) (*_nethttp.Response, error)

ListExecutionsForDevice Retrieve all Execution Items for a device Retrieve all Execution Items for a specific Device.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId
  • @param optional nil or *ListExecutionsForDeviceOpts - Optional Parameters:
  • @param "StateFilter" (optional.String) -
  • @param "Option" (optional.String) - <p>Possible values for the parameter:</p><h5>Paging operations</h5><ul><li><tt>size({page-size}) Maximum allowed page size is 200. Default page size is 25</tt></li><li><tt>cursor({cursor-id}) Start the search from the cursor location. Specify the cursor ID without quotation marks. Cursor IDs are given in search responses and mark the position after the last entry of the previous search. The meaning of cursor IDs is unspecified and may change without notice.</tt></li></ul><p><h4>Examples:</h4><ul><li><tt>size(10) return 10 results</tt></li><li><tt>cursor(LOREMIPSUM) return results after the position of the cursor LOREMIPSUM.</tt></li></ul><p><h5><b>Combine:</b></h5><p>If you need to specify multiple options, when using the swagger UI just write each option in a new line. When using the plain REST API programmatically, you will need to separate the options using a comma (,) character. size(200),cursor(LOREMIPSUM)

func (*TasksApiService) ListTasksForDevice 

func (a *TasksApiService) ListTasksForDevice(ctx _context.Context, deviceId string, localVarOptionals *ListTasksForDeviceOpts) (*_nethttp.Response, error)

ListTasksForDevice Retrieve all Tasks and respective execution status for a particular Device Retrieve all Tasks and respective execution status for a particular Device, which satisfies the applied state filter. The &lt;code&gt;freeTasks&lt;/code&gt; value of &lt;tt&gt;true&lt;/tt&gt; specifies that only Task executions not launched by any Rule should be retrieved, whereas the value of &lt;tt&gt;false&lt;/tt&gt; specifies that all Task executions will be retrieved (including those launched by Rules).&lt;p&gt;&lt;h4&gt;Available stateFilter values:&lt;/h4&gt; &lt;ui&gt;&lt;li&gt;&lt;tt&gt; FINISHED_SUCCESS(0) : Retrieve only Devices that have finished the Task execution with a sucess state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; FINISHED_WARNING(1) : Retrieve only Devices that have finished the Task execution with a warning state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; FINISHED_ERROR(2) : Retrieve only Devices that have finished the Task execution with an error state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; FINISHED_CANCELED(3) : Retrieve only Devices that have finished the Task execution with a canceled state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt; RUNNING(4) : Retrieve only Devices that have finished the Task execution with a running state&lt;/tt&gt;&lt;/li&gt; &lt;li&gt;&lt;tt&gt;FINISHED(64): This value unites all FINISHED_xxx values and could be used only as parameter for filtering&lt;/tt&gt;&lt;/li&gt;&lt;li&gt;&lt;tt&gt;ANY(128): Retrieve all involved Devices, regardless of the completion sate

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId
  • @param optional nil or *ListTasksForDeviceOpts - Optional Parameters:
  • @param "StateFilter" (optional.String) -
  • @param "FreeTasks" (optional.Bool) -
  • @param "Option" (optional.String) - <p>Possible values for the parameter:</p><h5>Paging operations</h5><ul><li><tt>size({page-size}) Maximum allowed page size is 200. Default page size is 25</tt></li><li><tt>cursor({cursor-id}) Start the search from the cursor location. Specify the cursor ID without quotation marks. Cursor IDs are given in search responses and mark the position after the last entry of the previous search. The meaning of cursor IDs is unspecified and may change without notice.</tt></li></ul><p><h4>Examples:</h4><ul><li><tt>size(10) return 10 results</tt></li><li><tt>cursor(LOREMIPSUM) return results after the position of the cursor LOREMIPSUM.</tt></li></ul><p><h5><b>Combine:</b></h5><p>If you need to specify multiple options, when using the swagger UI just write each option in a new line. When using the plain REST API programmatically, you will need to separate the options using a comma (,) character. size(200),cursor(LOREMIPSUM)

func (*TasksApiService) Options1 

func (a *TasksApiService) Options1(ctx _context.Context, taskId string) (*_nethttp.Response, error)

Options1 Retrieve the execution options of the Task Retrieve the execution options of the Task by the specified &lt;code&gt;taskId&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId

func (*TasksApiService) Properties1 

func (a *TasksApiService) Properties1(ctx _context.Context, taskId string) (*_nethttp.Response, error)

Properties1 Get the custom properties assigned to this Task Get the custom properties assigned to the Task with the specified &lt;code&gt;taskId&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId

func (*TasksApiService) RetryDevice1 

func (a *TasksApiService) RetryDevice1(ctx _context.Context, taskId string, deviceId string) (*_nethttp.Response, error)

RetryDevice1 Retry the Task over a Device Retry the Task over the Device with the specified &lt;code&gt;deviceId&lt;/code&gt;. Retrying forces: &lt;ui&gt;&lt;li&gt;&lt;tt&gt;partial executions that are not finished to be canceled&lt;/tt&gt;&lt;/li&gt;&lt;li&gt;&lt;tt&gt;all previous execution info for this Device within the Task to be deleted&lt;/tt&gt;&lt;/li&gt;&lt;li&gt;&lt;tt&gt;the action script of the Task to be run again for this Device&lt;/tt&gt;&lt;/li&gt;

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId
  • @param deviceId

func (*TasksApiService) RetryDevices1 

func (a *TasksApiService) RetryDevices1(ctx _context.Context, taskId string, stateFilter []string) (*_nethttp.Response, error)

RetryDevices1 Retry a Task over a particular Devices Retry the Task over the Devices whose status satisfies the applied state filter. Retrying forces: &lt;ui&gt;&lt;li&gt;&lt;tt&gt;partial executions that are not finished to be canceled&lt;/tt&gt;&lt;/li&gt;&lt;li&gt;&lt;tt&gt;all previous execution info for these Devices within the Task to be deleted&lt;/tt&gt;&lt;/li&gt;&lt;li&gt;&lt;tt&gt;the action script of the Task to be run again for these Devices&lt;/tt&gt;&lt;/li&gt;

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId
  • @param stateFilter

func (*TasksApiService) Rule1 

func (a *TasksApiService) Rule1(ctx _context.Context, taskId string) (*_nethttp.Response, error)

Rule1 Retrieve the Rule which launched this Task Retrieve the Rule which launched this Task or &lt;code&gt;204(NO_CONTENT)&lt;/code&gt; if Task was manually launched.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId

func (*TasksApiService) Scope1 

func (a *TasksApiService) Scope1(ctx _context.Context, taskId string) (*_nethttp.Response, error)

Scope1 Retrieve the Task scope Retrieve the scope of the Task with the specified &lt;code&gt;taskId&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId

func (*TasksApiService) SetProperties1 

func (a *TasksApiService) SetProperties1(ctx _context.Context, taskId string, localVarOptionals *SetProperties1Opts) (*_nethttp.Response, error)

SetProperties1 Set custom Task properties Set custom properties to the Task with the specified &lt;code&gt;taskId&lt;/code&gt;. If &lt;tt&gt; append &lt;/tt&gt; is &lt;tt&gt; true&lt;/tt&gt;, the supplied properties will be appended/added to any properties currently existing for this Task, otherwise any existing properties will be fully replaced by the supplied ones.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId
  • @param optional nil or *SetProperties1Opts - Optional Parameters:
  • @param "Properties" (optional.Interface of Properties) - Set or add Task properties

func (*TasksApiService) State1 

func (a *TasksApiService) State1(ctx _context.Context, taskId string) (string, *_nethttp.Response, error)

State1 Retrieve the state of the Task Retrieve the state of the Task with the specified &lt;code&gt;taskId&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId

@return string

func (*TasksApiService) Status 

func (a *TasksApiService) Status(ctx _context.Context, tasksId string) (TaskStatusInfo, *_nethttp.Response, error)

Status Retrieve a Task status Retrieve a Task status by a specified &lt;code&gt;taskId&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tasksId

@return TaskStatusInfo

func (*TasksApiService) TaskDevice 

func (a *TasksApiService) TaskDevice(ctx _context.Context, taskId string, deviceId string) (*_nethttp.Response, error)

TaskDevice Retrieve the Device task status in the scope of a Task Retrieve the Device task status of a particular Device in the scope of a Task.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId
  • @param deviceId

func (*TasksApiService) Tasks1 

func (a *TasksApiService) Tasks1(ctx _context.Context, localVarOptionals *Tasks1Opts) (*_nethttp.Response, error)

Tasks1 Retrieve all Tasks 

Retrieve all available Tasks that satisfy the filtering criteria.
* @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param optional nil or *Tasks1Opts - Optional Parameters:
* @param "Filter" (optional.String) -  An RQL filter over the Task attributes.<h5></tt><br/>The attribute names in the filtering conditions can be some of:</h5> <ui><tt><li/><b>state</b> - integer value corresponding to the Task state as follows: </tt> <br/><br/><tt>1 - RUNNING </tt><br/><tt> 2 - FINISHED</tt> <br/><tt>3 - FAILED_TO_LAUNCH</tt> <li/><tt><b>stateDescription</b> - string value corresponding to the state description </tt><li/><tt><b> involvedCount</b> - integer value corresponding to the the number of involved Devices in the Task.</tt> <li/><tt><b> successCount</b> - integer value corresponding to the the number of successfully finished Devices in the Task</tt><li/><tt><b>warningCount</b> - integer value corresponding the the number of Devices finished with warning in the Task </tt><li/><tt><b> errorCount</b> - integer value corresponding to the the number of Devices finished with error in the Task.</tt> <li/><tt><b>cancelCount</b> - integer value corresponding to the the number of Devices finished with warning in the Task.</tt><li/><tt><b>launchTime</b> - long value corresponding to the Task launch time given as milliseconds since 1 Jan 1970</tt><li/><tt><b>finishTime</b> - long value corresponding to the Task finish time given as milliseconds since 1 Jan 1970</tt><li/><tt><b>isPaused</b> - boolean value that is <code>true</code> when the execution is paused due to time constraint restrictions </tt><li/><tt><b>nextResume</b> - corresponds to resume time (in milliseconds since 1 Jan 1970) if the Task is currently paused </tt><li/><tt><b>nextPause</b> - corresponds to the next pause time (in milliseconds since 1 Jan 1970) if the Task is currently not paused </tt><li/><tt><b>taskId</b> - string value corresponding to the Task id</tt><li/><tt><b>ruleId</b> - string value corresponding to the Rule id if the Task is launched by a Rule trigger</tt><li/><tt><b>user</b> -string value corresponding to the user name of the user that has launched the Task<li/><tt><b>action</b> - string value corresponding to a textual representation of the searched action</tt><li/><tt><b>displayName</b> - string value corresponding the Task display name</tt><h4>Filter operations:</h4><ui><li><tt>eq({property},{value})</tt></li><li><tt>ne({property},{value})</tt></li><li><tt>gt({property},{value})</tt></li><li><tt>ge({property},{value})</tt></li><li><tt>lt({property},{value})</tt></li><li><tt>le({property},{value})</tt></li><li><tt>in({property},{value},{value},...)</tt></li><li><tt>like({property},{value})</tt></li><li><tt>exists({property})</tt></li></ui>Note: When using filter operations, only Tasks with the specified properties are returned.<h4>Logical operations:</h4><ui><li><tt>and({query},{query},...)</tt></li><li><tt>or({query},{query},...)</tt></li><li><tt>not({query})</tt></li></ui><h5>Examples:</h5><ui><li><tt>eq(state,\"0\")</tt></li><li><tt>and(eq(involvedCount,2),eq(state,0))</tt></li></ui>
* @param "Option" (optional.String) -  <p>Possible values for the parameter:</p><h5>Paging operations</h5><ul><li><tt>size({page-size}) Maximum allowed page size is 200. Default page size is 25</tt></li><li><tt>cursor({cursor-id}) Start the search from the cursor location. Specify the cursor ID without quotation marks. Cursor IDs are given in search responses and mark the position after the last entry of the previous search. The meaning of cursor IDs is unspecified and may change without notice.</tt></li></ul><p><h4>Examples:</h4><ul><li><tt>size(10) return 10 results</tt></li><li><tt>cursor(LOREMIPSUM) return results after the position of the cursor LOREMIPSUM.</tt></li></ul><p><h5><b>Combine:</b></h5><p>If you need to specify multiple options, when using the swagger UI just write each option in a new line. When using the plain REST API programmatically, you will need to separate the options using a comma (,) character. size(200),cursor(LOREMIPSUM)

type TasksOpts 

type TasksOpts struct {
	Filter optional.String
	Option optional.String
}

TasksOpts Optional parameters for the method 'Tasks'

type TriggerElInfo 

type TriggerElInfo struct {
	// A groovy script that will be executed and expected to return a boolean result or it might be a json query filter that will be matched against the Rule-fire event
	Condition    string           `json:"condition,omitempty"`
	TriggerEvent TriggerEventInfo `json:"triggerEvent,omitempty"`
}

TriggerElInfo Should be a groovy script that could be evaluated to boolean value <code>true</code> or <code>false</code>.

type TriggerEventInfo 

type TriggerEventInfo struct {
	EventType string `json:"eventType,omitempty"`
	// The trigger type - corresponding to a trigger provider available in the system
	Mode string `json:"mode"`
	// The input required by the respective trigger provider in order to start generating Rule firing events. For mme.manual.trigger mode this is not required
	ActivationParams string `json:"activationParams"`
}

TriggerEventInfo Abstraction for event that fires a Rule

type TriggerInfo 

type TriggerInfo struct {
	// Should be a groovy script that could be evaluated to boolean value <code>true</code> or <code>false</code>.
	GeneralCondition string `json:"generalCondition,omitempty"`
	// Should be a groovy script that could be evaluated to boolean value <code>true</code> or <code>false</code>.
	TriggerElements []TriggerElInfo `json:"triggerElements"`
}

TriggerInfo struct for TriggerInfo

type UnregisterOpts 

type UnregisterOpts struct {
	KeepCredentials optional.Bool
	KeepPolicy      optional.Bool
}

UnregisterOpts Optional parameters for the method 'Unregister'

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.