import InternalOpenGateAPI from 'opengate-js/src/InternalOpenGateAPI.js'

public class | source

InternalOpenGateAPI

This is a abstract class, it must be extended to another class that defined the backend, it will be used on request to Opengate North API by browser or nodejs server

Test:

Check if all searching modules exists:

Constructor Summary

Public Constructor
public	constructor(_options: {url: string, port: string, version: string, apiKey: string}, ampliaREST: AmpliaREST) Constructor

Member Summary

Public Members
public	EX: *
public	Napi: *
public	SE: *
public	Sapi: *
public	alarms: *
public	entityBuilder: *
public	operations: *

Method Summary

Public Methods
public	administrativeStateSearchBuilder(): AdministrativeStateSearchBuilder This return a AdministrativeStateSearchBuilder to build a specific AdministrativeStateSearchBuilder
public	alarmsSearchBuilder(): AlarmsSearchBuilder This return a AlarmsSearchBuilder to build a specific AlarmsSearch
public	allowedResourceTypeSearchBuilder(): AllowedResourceTypeSearchBuilder This return a AllowedResourceTypeSearchBuilder to build a specific AllowedResourceTypeSearchBuilder
public	areasBuilder(): Areas This return a AreasBuilder to build a specific area
public	areasSearchBuilder(): AreasSearchBuilder This return a AreasSearchBuilder to build a specific AreasSearch
public	assetsSearchBuilder(): AssetsSearchBuilder This return a AssetsSearchBuilder to build a specific AssetSearch
public	basicTypesSearchBuilder(): *
public	bulkExecutionBuilder(organization: , processorId: , timeout: *): BulkExecutionBuilder This return a util to create a bulk execution
public	bulkExecutionSearchBuilder(): BulkExecutionSearchBuilder This return a BulkExecutionSearchBuilder to build a specific bulk
public	bulkSearchBuilder(): BulkSearchBuilder This return a BulkSearchBuilder to build a specific BulkSearchBuilder
public	bundlesBuilder(): Bundles This return a BundlesBuilder to build a specific BundlesBuilder
public	bundlesSearchBuilder(): BundlesSearchBuilder This return a BundlesSearchBuilder to build a specific BundlesSearchBuilder
public	certificatesBuilder(): Certificates This return a util to create a certificate
public	certificatesSearchBuilder(): CertificatesSearchBuilder This return a CertificatesSearchBuilder to build a specific CertificatesSearchBuilder
public	channelsBuilder(): Channels This return a ChannelsBuilder to build a specific WorkgroupsSearch
public	channelsSearchBuilder(): ChannelsSearchBuilder This return a ChannelsSearchBuilder to build a specific ChannelsSearch
public	commsModuleMessageMessageBuilder(): CommsModuleMessage
public	communicationsModuleTypeSearchBuilder(): CommunicationsModuleTypeSearchBuilder This return a CommunicationsModuleTypeSearchBuilder to build a specific CommunicationsModuleTypeSearch
public	connectorFunctionsBuilder(organization: , channel: , identifier: , connectorFunctionData: ): ConnectorFunctions This return a ConnectorFunctions
public	connectorFunctionsCatalogBuilder(identifier: String, connectorFunctionsCatalog: Object): ConnectorFunctionsCatalog
public	countryCodesSearchBuilder(): CountryCodesSearchBuilder This return a CountryCodesSearchBuilder to build a specific CountryCodesSearchBuilder
public	datamodelsBuilder(organization: *): Datamodels This return a Datamodels to build a specific Datamodels
public	datamodelsHelper(organization: , datamodel: ): DatamodelsHelper This return a DatamodelsHelper to build a specific DatamodelsHelper
public	datamodelsSearchBuilder(): DatamodelsSearchBuilder This return a DatamodelsSearchBuilder to build a specific DatamodelsSearchBuilder
public	datapointsBuilder(): Datapoint This return a datapointsBuilder to build a specific Datapoint
public	datapointsSearchBuilder(): DatapointsSearchBuilder This return a DatapointsSearchBuilder to build a specific DatapointsSearchBuilder
public	datasetEntitiesSearchBuilder(organization: , dataset: ): DatasetEntitiesSearchBuilder This return a DatasetEntitiesSearchBuilder to build a specific DatasetEntitiesSearch
public	datasetSearchBuilder(organization: , dataset: ): DatasetSearchBuilder This return a DatasetSearchBuilder to build a specific DatasetSearch
public	datasetsBuilder(): Datasets This return a DatasetBuilder to build a specific dataset
public	datasetsCatalogSearchBuilder(): DatasetsCatalogSearchBuilder This return a DatasetsCatalogSearchBuilder to build a specific DatasetsCatalogSearc
public	datastreamBuilder(): Datastream This return a datastreamBuilder to build a specific Datastream
public	datastreamsBuilder(): DatastreamsBuilder This return a datastream to build a specific Datastream
public	datastreamsSearchBuilder(): DatastreamsSearchBuilder This return a DatastreamsSearchBuilder to build a specific DatastreamsSearchBuilder
public	deviceMessageBuilder(): DeviceMessage This return a DevicesSouth to build a specific DevicesSouth
public	devicesPlansSearchBuilder(): PlansSearchBuilder This return a DevicePlansSearchBuilder to build a specific DevicePlansSearchBuilder
public	devicesSearchBuilder(): DevicesSearchBuilder This return a DevicesSearchBuilder to build a specific DeviceSearch
public	domainsBuilder(): Domain This return a DomainsBuilder to build a specific DomainsBuilder
public	domainsSearchBuilder(): DomainsSearchBuilder This return a DomainsSearchBuilder to build a specific DomainsSearch
public	entitiesSearchBuilder(): EntitiesSearchBuilder This return a EntitiesSearchBuilder to build a specific EntitiesSearch
public	executionsHistorySearchBuilder(): ExecutionsHistorySearchBuilder This return a ExecutionsHistorySearchBuilder to build a specific ExecutionsSearch
public	executionsSearchBuilder(): ExecutionsSearchBuilder This return a ExecutionsSearchBuilder to build a specific ExecutionsSearch
public	feedsSearchBuilder(): FeedsSearchBuilder This return a FeedsSearchBuilder to build a specific FeedsSearchBuilder
public	fieldsDefinitionSearchBuilder(): FieldsDefinitionSearchBuilder This return a FieldsDefinitionSearchBuilder to build a specific FieldsDefinitionSearchBuilder
public	geoclusterBuilder(): Geocluster This return a util to regenerate geloclouster
public	hardwareMessageBuilder(): Hardware
public	ioTDatastreamAccessSearchBuilder(): IoTDatastreamAccessSearchBuilder This return a IoTDatastreamAccessSearchBuilder to build a specific IoTDatastreamAccessSearchBuilder
public	ioTDatastreamPeriodSearchBuilder(): IoTDatastreamPeriodSearchBuilder This return a IoTDatastreamPeriodSearchBuilder to build a specific IoTDatastreamPeriodSearchBuilder
public	ioTDatastreamStoragePeriodSearchBuilder(): IoTDatastreamStoragePeriodSearchBuilder This return a IoTDatastreamStoragePeriodSearchBuilder to build a specific IoTDatastreamStoragePeriodSearchBuilder
public	manufacturerModelsBuilder(manufacturerIdentifier: *): ManufacturerModelsBuilder This return a ManufacturerModelsBuilder to build a specific ManufacturerModelsBuilder
public	manufacturersBuilder(): ManufacturersBuilder This return a ManufacturersBuilder to build a specific ManufacturersBuilder
public	mobileMessageMessageBuilder(): Mobile
public	mobilePhoneProviderSearchBuilder(): MobilePhoneProviderSearchBuilder This return a MobilePhoneProviderSearchBuilder to build a specific MobilePhoneProviderTypeSearch
public	newAreaFinder(): AreaFinder This return a util to find a area
public	newBulkExecutionFinder(): BulkFinder This return a util to find summary and download a bulk executions
public	newBulkFinder(): BulkFinder This return a util to find and download a bulk
public	newBundleFinder(): BundleFinder This return a util to find a bundle
public	newCertificateFinder(): CertificateFinder This return a util to find a certificate
public	newChannelFinder(): ChannelFinder This return a util to find a channel
public	newConnectorFunctionsCatalog(): ConnectorFunctionsCatalog This return a ConnectorFunctionsCatalog
public	newConnectorFunctionsCatalogFinder(): ConnectorFunctionsCatalogFinder This return a ConnectorFunctionsCatalogFinder
public	newConnectorFunctionsFinder(): ConnectorFunctionsFinder This return a ConnectorFunctionsFinder
public	newConnectorFunctionsHelper(): ConnectorFunctionsHelper This return a ConnectorFunctionsHelper
public	newCountriesCatalog(): CountriesCatalog This return a util to find countries catalog
public	newDatamodelsFinder(): DatamodelsFinder This return a util to find a datamodel
public	newDatasetFinder(): DatasetFinder This return a to find Dataset configuration
public	newDeviceFinder(): DeviceFinder This return a util to find a device
public	newDomainFinder(): DomainFinder This return a util to find a domain
public	newEntityFinder(): *
public	newFilterBuilder(): FilterBuilder This return a util to create your own filter to make searching
public	newGeoclusterFinder(): GeoclusterFinder This return a util to find a user
public	newManufacturersFinder(): ManufacturerFinder This return a util to find a hardware manufacturer
public	newModelFinder(): ModelFinder This return a util to find a hardware model
public	newNotebookFinder(): NotebookFinder This return a util to find notebooks
public	newNotebookSchedulerFinder(): NotebookSchedulerFinder This return a util to find notebooks schedulers
public	newOperationActions(operationId: string): OperationActions This return a util to operation actions on an operation
public	newOperationFinder(): OperationFinder This return a util to find a operation
public	newOperationTypeCatalog(): OperationTypeCatalog This return a util to find Operation Types Templates
public	newOperationTypeFinder(): OperationType This return a util to find Operation Types
public	newOrganizationFinder(): OrganizationFinder This return a util to find a organization
public	newOrganizationManufacturersFinder(): OrganizationManufacturerFinder This return a util to find a hardware manufacturer
public	newOrganizationModelFinder(): OrganizationModelFinder This return a util to find a hardware model
public	newPeriodicityActions(taskId: string): PeriodicityActions This return a util to manage actions over periodicities
public	newProvisionProcessorsFinder(): ProvisionProcessorsFinder This return a util to find a provision procesor
public	newRuleConfigurationsCatalog(): RuleConfigurationsCatalog This return a util to find Rule Configurations Templates
public	newRuleConfigurationsFinder(): RuleConfigurationsFinder This return a util to find Rule Configurations
public	newRuleConfigurationsHelper(): * This return a util RuleConfigurationsHelper
public	newScheduleHistoryFinder(): HistoryFinder This return a util to view schedule history
public	newScheduleImageExecutionFinder(): ImageExecutionFinder This return a util to view schedule image executions
public	newSchedulePipelineFinder(): PipelineFinder This return a util to view schedule pipelines
public	newScheduleRestRequestFinder(): RestRequestFinder This return a util to view schedule rest requests
public	newSelectBuilder(): SelectBuilder This return a util to create your own select to make searching
public	newSoftwareFinder(): SoftwareFinder This return a util to find an organization software
public	newSubscribersFinder(): SubscribersFinder This return a util to find a Subscriber
public	newSubscriptionsFinder(): SubscriptionsFinder This return a util to find a Subscription
public	newTicketFinder(): TicketFinder This return a util to find a ticket
public	newTimeserieFinder(): TimeserieFinder This return a to find Timeserie configuration
public	newTimeseriesFunctionFinder(): TimeseriesFunctionsFinder This return a util to find a timeseries function
public	newTimeseriesFunctionsHelper(): TimeseriesFunctionsHelper This return a TimeseriesFunctionsHelper
public	newUserFinder(): UserFinder This return a util to find a user
public	newWorkgroupFinder(): WorkgroupFinder This return a util to find a workgroup
public	newWorkgroupRelationsFinder(): WorkgroupRelationsFinder This return a WorkgroupRelationsFinder
public	notebookLauncherBuilder(): NotebookLauncherBuilder This return a NotebookLauncherBuilder to build a specific NotebookLauncherBuilder
public	notebookSchedulerBuilder(): NotebookSchedulerBuilder This return a NotebookSchedulerBuilder to build a specific NotebookSchedulerBuilder
public	operationTypeBuilder(organization: , name: , operationTypeObj: *): OperationType This return a util to update an Operation Type
public	operationTypesSearchBuilder(): OperationTypesSearchBuilder This return a OperationTypesSearchBuilder to build a specific OperationTypesSearch
public	operationalStatusSearchBuilder(): OperationalStatusSearchBuilder This return a OperationalStatusSearchBuilder to build a specific OperationalStatusSearchBuilder
public	operationsSearchBuilder(): OperationsSearchBuilder This return a OperationsSearchBuilder to build a specific ExecutionssSearch
public	organizationManufacturerModelsBuilder(organization: , manufacturerIdentifier: ): OrganizationManufacturerModelsBuilder This return a OrganizationManufacturerModelsBuilder to build a specific OrganizationManufacturerModelsBuilder
public	organizationManufacturersBuilder(organization: *): OrganizationManufacturersBuilder This return a OrganizationManufacturersBuilder to build a specific OrganizationManufacturersBuilder
public	organizationsBuilder(): Organizations This return a OrganizationsBuilder to build a specific OrganizationsBuilder
public	plansSearchBuilder(): PlansSearchBuilder This return a PlansSearchBuilder to build a specific PlansSearchBuilder
public	powerSupplyMessageBuilder(): PowerSupply
public	provisionProcessorsBuilder(): provisionProcessorsBuilder This return a ProvisionsProcesorsBuilder to build a specific ProvisionsProcesorsBuilder
public	qratingsBuilder(): QratingsBuilder This return a Qrating to build a specific Qrating
public	rawSearchBuilder(): RawSearchBuilder Create custom search with custom url and raw filter
public	resourceTypeSearchBuilder(): ResourceTypeSearchBuilder This return a ResourceTypeSearchBuilder to build a specific ResourceTypeSearchBuilder
public	ruleConfigurationBuilder(organization: , channel: , name: , ruleConfigObj: ): RuleConfigurations This return a util to update a Rule Configuration
public	rulesSearchBuilder(): RulesSearchBuilder This return a RulesSearchBuilder to build a specific RulesSearch
public	scheduleImageExecutionBuilder(): ImageExecution This return a util to build schedule image executions
public	schedulePipelineBuilder(): SchedulePipeline This return a util to build a pipeline
public	scheduleRestRequestBuilder(): RestRequest This return a util to build schedule rest requests
public	serviceGroupSearchBuilder(): ServiceGroupSearchBuilder This return a ServiceGroupSearchBuilder to build a specific ServiceGroupSearchBuilder
public	softwareMessageBuilder(): Software
public	softwaresBuilder(organization: *): SoftwaresBuilder This return a SoftwaresBuilder to build a specific SoftwaresBuilder
public	softwaresSearchBuilder(): SoftwaresSearchBuilder This return a SoftwaresSearchBuilder to build a specific SoftwaresSearchBuilder
public	storageMessageBuilder(): Storage
public	subscriberMessageBuilder(): SubscriberMessage
public	subscribersSearchBuilder(): SubscribersSearchBuilder This return a SubscribersSearchBuilder to build a specific DeviceSearch
public	subscriptionMessageBuilder(): SubscriptionMessage
public	subscriptionsSearchBuilder(): SubscriptionsSearchBuilder This return a SubscriptionsSearchBuilder to build a specific DeviceSearch
public	tasksSearchBuilder(): TasksSearchBuilder This return a TasksSearchBuilder to build a specific TasksSearch
public	ticketPrioritySearchBuilder(): TicketPrioritySearchBuilder This return a TicketPrioritySearchBuilder to build a specific TicketPrioritySearchBuilder
public	ticketSeveritySearchBuilder(): TicketSeveritySearchBuilder This return a TicketSeveritySearchBuilder to build a specific TicketSeveritySearchBuilder
public	ticketStatusSearchBuilder(): TicketStatusSearchBuilder This return a TicketStatusSearchBuilder to build a specific TicketStatusSearchBuilder
public	ticketsSearchBuilder(): * This return a TicketsSearchBuilder to build a specific TicketSearch
public	timeserieDatasetBuilder(organization: , timeserie: ): TimeserieDatasetBuilder This return a TimeserieDatasetBuilder to build a specific TimeserieDataset
public	timeserieDownsamplerBuilder(organization: , timeserie: , entityId: *): TimeserieDownsamplerBuilder This return a TimeserieDownsamplerBuilder to build a specific TimeserieDownsampler
public	timeserieSearchBuilder(organization: , timeserie: ): TimeserieSearchBuilder This return a TimeserieSearchBuilder to build a specific TimeserieSearch
public	timeseriesBuilder(): Timeseries This return a TimeserieBuilder to build a specific timeserie
public	timeseriesFunctionBuilder(organization: , identifier: ): TimeseriesFunction This return a TimeserieBuilder to build a specific timeserie
public	timezoneSearchBuilder(): TimezoneSearchBuilder This return a TimezoneSearchBuilder to build a specific TimezoneSearchBuilder
public	usageMessageBuilder(): Usage
public	userLanguagesSearchBuilder(): UserLanguagesSearchBuilder This return a UserLanguagesSearchBuilder to build a specific UserLanguagesSearchBuilder
public	userProfilesSearchBuilder(): UserProfilesSearchBuilder This return a UserProfilesSearchBuilder to build a specific UserProfilesSearchBuilder
public	usersBuilder(): User This return a util to create a user
public	usersSearchBuilder(): UsersSearchBuilder This return a UsersSearchBuilder to build a specific UsersSearch
public	workgroupRelationsBuilder(): WorkgroupRelations This return a WorkgroupRelationsBuilder to build a specific workgroup relation
public	workgroupsBuilder(): Workgroups This return a WorkgroupsBuilder to build a specific workgroup
public	workgroupsSearchBuilder(): WorkgroupsSearchBuilder This return a WorkgroupsSearchBuilder to build a specific WorkgroupsSearch

Public Constructors

public constructor(_options: {url: string, port: string, version: string, apiKey: string}, ampliaREST: AmpliaREST) source

Constructor

Params:

Name	Type	Attribute	Description
_options	{url: string, port: string, version: string, apiKey: string}		this is configuration about Opengate North API.
ampliaREST	AmpliaREST		this is a backend selected to manage a request to Opengate North API.

Public Members

public EX: * source

public Napi: * source

public SE: * source

public Sapi: * source

public alarms: * source

public entityBuilder: * source

public operations: * source

Public Methods

public administrativeStateSearchBuilder(): AdministrativeStateSearchBuilder source

This return a AdministrativeStateSearchBuilder to build a specific AdministrativeStateSearchBuilder

Return:

AdministrativeStateSearchBuilder

public alarmsSearchBuilder(): AlarmsSearchBuilder source

This return a AlarmsSearchBuilder to build a specific AlarmsSearch

Return:

AlarmsSearchBuilder

Test:

public allowedResourceTypeSearchBuilder(): AllowedResourceTypeSearchBuilder source

This return a AllowedResourceTypeSearchBuilder to build a specific AllowedResourceTypeSearchBuilder

Return:

AllowedResourceTypeSearchBuilder

public areasBuilder(): Areas source

This return a AreasBuilder to build a specific area

Return:

Areas

public areasSearchBuilder(): AreasSearchBuilder source

This return a AreasSearchBuilder to build a specific AreasSearch

Return:

AreasSearchBuilder

public assetsSearchBuilder(): AssetsSearchBuilder source

This return a AssetsSearchBuilder to build a specific AssetSearch

Return:

AssetsSearchBuilder

public basicTypesSearchBuilder(): * source

Return:

public bulkExecutionBuilder(organization: , processorId: , timeout: *): BulkExecutionBuilder source

This return a util to create a bulk execution

Params:

Name	Type	Attribute	Description
organization	*
processorId	*
timeout	*

Return:

BulkExecutionBuilder

public bulkExecutionSearchBuilder(): BulkExecutionSearchBuilder source

This return a BulkExecutionSearchBuilder to build a specific bulk

Return:

BulkExecutionSearchBuilder

public bulkSearchBuilder(): BulkSearchBuilder source

This return a BulkSearchBuilder to build a specific BulkSearchBuilder

Return:

BulkSearchBuilder

public bundlesBuilder(): Bundles source

This return a BundlesBuilder to build a specific BundlesBuilder

Return:

Bundles

Test:

public bundlesSearchBuilder(): BundlesSearchBuilder source

This return a BundlesSearchBuilder to build a specific BundlesSearchBuilder

Return:

BundlesSearchBuilder

Test:

public certificatesBuilder(): Certificates source

This return a util to create a certificate

Return:

Certificates

Test:

Check funcionality certificates:

public certificatesSearchBuilder(): CertificatesSearchBuilder source

This return a CertificatesSearchBuilder to build a specific CertificatesSearchBuilder

Return:

CertificatesSearchBuilder

public channelsBuilder(): Channels source

This return a ChannelsBuilder to build a specific WorkgroupsSearch

Return:

Channels

public channelsSearchBuilder(): ChannelsSearchBuilder source

This return a ChannelsSearchBuilder to build a specific ChannelsSearch

Return:

ChannelsSearchBuilder

public commsModuleMessageMessageBuilder(): CommsModuleMessage source

Return:

CommsModuleMessage

public communicationsModuleTypeSearchBuilder(): CommunicationsModuleTypeSearchBuilder source

This return a CommunicationsModuleTypeSearchBuilder to build a specific CommunicationsModuleTypeSearch

Return:

CommunicationsModuleTypeSearchBuilder

public connectorFunctionsBuilder(organization: , channel: , identifier: , connectorFunctionData: ): ConnectorFunctions source

This return a ConnectorFunctions

Params:

Name	Type	Attribute	Description
organization	*
channel	*
identifier	*
connectorFunctionData	*

Return:

ConnectorFunctions

public connectorFunctionsCatalogBuilder(identifier: String, connectorFunctionsCatalog: Object): ConnectorFunctionsCatalog source

Params:

Name	Type	Attribute	Description
identifier	String		only update or delete
connectorFunctionsCatalog	Object

Return:

ConnectorFunctionsCatalog

public countryCodesSearchBuilder(): CountryCodesSearchBuilder source

This return a CountryCodesSearchBuilder to build a specific CountryCodesSearchBuilder

Return:

CountryCodesSearchBuilder

public datamodelsBuilder(organization: *): Datamodels source

This return a Datamodels to build a specific Datamodels

Params:

Name	Type	Attribute	Description
organization	*

Return:

Datamodels

public datamodelsHelper(organization: , datamodel: ): DatamodelsHelper source

This return a DatamodelsHelper to build a specific DatamodelsHelper

Params:

Name	Type	Attribute	Description
organization	*
datamodel	*

Return:

DatamodelsHelper

public datamodelsSearchBuilder(): DatamodelsSearchBuilder source

This return a DatamodelsSearchBuilder to build a specific DatamodelsSearchBuilder

Return:

DatamodelsSearchBuilder

public datapointsBuilder(): Datapoint source

This return a datapointsBuilder to build a specific Datapoint

Return:

Datapoint

public datapointsSearchBuilder(): DatapointsSearchBuilder source

This return a DatapointsSearchBuilder to build a specific DatapointsSearchBuilder

Return:

DatapointsSearchBuilder

Test:

public datasetEntitiesSearchBuilder(organization: , dataset: ): DatasetEntitiesSearchBuilder source

This return a DatasetEntitiesSearchBuilder to build a specific DatasetEntitiesSearch

Params:

Name	Type	Attribute	Description
organization	*
dataset	*

Return:

DatasetEntitiesSearchBuilder

public datasetSearchBuilder(organization: , dataset: ): DatasetSearchBuilder source

This return a DatasetSearchBuilder to build a specific DatasetSearch

Params:

Name	Type	Attribute	Description
organization	*
dataset	*

Return:

DatasetSearchBuilder

public datasetsBuilder(): Datasets source

This return a DatasetBuilder to build a specific dataset

Return:

Datasets

public datasetsCatalogSearchBuilder(): DatasetsCatalogSearchBuilder source

This return a DatasetsCatalogSearchBuilder to build a specific DatasetsCatalogSearc

Return:

DatasetsCatalogSearchBuilder

public datastreamBuilder(): Datastream source

This return a datastreamBuilder to build a specific Datastream

Return:

Datastream

public datastreamsBuilder(): DatastreamsBuilder source

This return a datastream to build a specific Datastream

Return:

DatastreamsBuilder

public datastreamsSearchBuilder(): DatastreamsSearchBuilder source

This return a DatastreamsSearchBuilder to build a specific DatastreamsSearchBuilder

Return:

DatastreamsSearchBuilder

public deviceMessageBuilder(): DeviceMessage source

This return a DevicesSouth to build a specific DevicesSouth

Return:

DeviceMessage

public devicesPlansSearchBuilder(): PlansSearchBuilder source

This return a DevicePlansSearchBuilder to build a specific DevicePlansSearchBuilder

Return:

PlansSearchBuilder

public devicesSearchBuilder(): DevicesSearchBuilder source

This return a DevicesSearchBuilder to build a specific DeviceSearch

Return:

DevicesSearchBuilder

Test:

public domainsBuilder(): Domain source

This return a DomainsBuilder to build a specific DomainsBuilder

Return:

Domain

public domainsSearchBuilder(): DomainsSearchBuilder source

This return a DomainsSearchBuilder to build a specific DomainsSearch

Return:

DomainsSearchBuilder

public entitiesSearchBuilder(): EntitiesSearchBuilder source

This return a EntitiesSearchBuilder to build a specific EntitiesSearch

Return:

EntitiesSearchBuilder

public executionsHistorySearchBuilder(): ExecutionsHistorySearchBuilder source

This return a ExecutionsHistorySearchBuilder to build a specific ExecutionsSearch

Return:

ExecutionsHistorySearchBuilder

public executionsSearchBuilder(): ExecutionsSearchBuilder source

This return a ExecutionsSearchBuilder to build a specific ExecutionsSearch

Return:

ExecutionsSearchBuilder

Test:

public feedsSearchBuilder(): FeedsSearchBuilder source

This return a FeedsSearchBuilder to build a specific FeedsSearchBuilder

Return:

FeedsSearchBuilder

public fieldsDefinitionSearchBuilder(): FieldsDefinitionSearchBuilder source

This return a FieldsDefinitionSearchBuilder to build a specific FieldsDefinitionSearchBuilder

Return:

FieldsDefinitionSearchBuilder

public geoclusterBuilder(): Geocluster source

This return a util to regenerate geloclouster

Return:

Geocluster

public hardwareMessageBuilder(): Hardware source

Return:

Hardware

public ioTDatastreamAccessSearchBuilder(): IoTDatastreamAccessSearchBuilder source

This return a IoTDatastreamAccessSearchBuilder to build a specific IoTDatastreamAccessSearchBuilder

Return:

IoTDatastreamAccessSearchBuilder

public ioTDatastreamPeriodSearchBuilder(): IoTDatastreamPeriodSearchBuilder source

This return a IoTDatastreamPeriodSearchBuilder to build a specific IoTDatastreamPeriodSearchBuilder

Return:

IoTDatastreamPeriodSearchBuilder

public ioTDatastreamStoragePeriodSearchBuilder(): IoTDatastreamStoragePeriodSearchBuilder source

This return a IoTDatastreamStoragePeriodSearchBuilder to build a specific IoTDatastreamStoragePeriodSearchBuilder

Return:

IoTDatastreamStoragePeriodSearchBuilder

public manufacturerModelsBuilder(manufacturerIdentifier: *): ManufacturerModelsBuilder source

This return a ManufacturerModelsBuilder to build a specific ManufacturerModelsBuilder

Params:

Name	Type	Attribute	Description
manufacturerIdentifier	*

Return:

ManufacturerModelsBuilder

public manufacturersBuilder(): ManufacturersBuilder source

This return a ManufacturersBuilder to build a specific ManufacturersBuilder

Return:

ManufacturersBuilder

public mobileMessageMessageBuilder(): Mobile source

Return:

Mobile

public mobilePhoneProviderSearchBuilder(): MobilePhoneProviderSearchBuilder source

This return a MobilePhoneProviderSearchBuilder to build a specific MobilePhoneProviderTypeSearch

Return:

MobilePhoneProviderSearchBuilder

public newAreaFinder(): AreaFinder source

This return a util to find a area

Return:

AreaFinder

public newBulkExecutionFinder(): BulkFinder source

This return a util to find summary and download a bulk executions

Return:

BulkFinder

public newBulkFinder(): BulkFinder source

This return a util to find and download a bulk

Return:

BulkFinder

public newBundleFinder(): BundleFinder source

This return a util to find a bundle

Return:

BundleFinder

public newCertificateFinder(): CertificateFinder source

This return a util to find a certificate

Return:

CertificateFinder

public newChannelFinder(): ChannelFinder source

This return a util to find a channel

Return:

ChannelFinder

public newConnectorFunctionsCatalog(): ConnectorFunctionsCatalog source

This return a ConnectorFunctionsCatalog

Return:

ConnectorFunctionsCatalog

public newConnectorFunctionsCatalogFinder(): ConnectorFunctionsCatalogFinder source

This return a ConnectorFunctionsCatalogFinder

Return:

ConnectorFunctionsCatalogFinder

public newConnectorFunctionsFinder(): ConnectorFunctionsFinder source

This return a ConnectorFunctionsFinder

Return:

ConnectorFunctionsFinder

public newConnectorFunctionsHelper(): ConnectorFunctionsHelper source

This return a ConnectorFunctionsHelper

Return:

ConnectorFunctionsHelper

public newCountriesCatalog(): CountriesCatalog source

This return a util to find countries catalog

Return:

CountriesCatalog

public newDatamodelsFinder(): DatamodelsFinder source

This return a util to find a datamodel

Return:

DatamodelsFinder

public newDatasetFinder(): DatasetFinder source

This return a to find Dataset configuration

Return:

DatasetFinder

public newDeviceFinder(): DeviceFinder source

This return a util to find a device

Return:

DeviceFinder

public newDomainFinder(): DomainFinder source

This return a util to find a domain

Return:

DomainFinder

public newEntityFinder(): * source

Return:

public newFilterBuilder(): FilterBuilder source

This return a util to create your own filter to make searching

Return:

FilterBuilder

Test:

Check funcionality FilterBuilder module:

public newGeoclusterFinder(): GeoclusterFinder source

This return a util to find a user

Return:

GeoclusterFinder

public newManufacturersFinder(): ManufacturerFinder source

This return a util to find a hardware manufacturer

Return:

ManufacturerFinder

public newModelFinder(): ModelFinder source

This return a util to find a hardware model

Return:

ModelFinder

public newNotebookFinder(): NotebookFinder source

This return a util to find notebooks

Return:

NotebookFinder

public newNotebookSchedulerFinder(): NotebookSchedulerFinder source

This return a util to find notebooks schedulers

Return:

NotebookSchedulerFinder

public newOperationActions(operationId: string): OperationActions source

This return a util to operation actions on an operation

Params:

Name	Type	Attribute	Description
operationId	string	nullable: false	identifier of operation

Return:

OperationActions

public newOperationFinder(): OperationFinder source

This return a util to find a operation

Return:

OperationFinder

public newOperationTypeCatalog(): OperationTypeCatalog source

This return a util to find Operation Types Templates

Return:

OperationTypeCatalog

public newOperationTypeFinder(): OperationType source

This return a util to find Operation Types

Return:

OperationType

public newOrganizationFinder(): OrganizationFinder source

This return a util to find a organization

Return:

OrganizationFinder

public newOrganizationManufacturersFinder(): OrganizationManufacturerFinder source

This return a util to find a hardware manufacturer

Return:

OrganizationManufacturerFinder

public newOrganizationModelFinder(): OrganizationModelFinder source

This return a util to find a hardware model

Return:

OrganizationModelFinder

public newPeriodicityActions(taskId: string): PeriodicityActions source

This return a util to manage actions over periodicities

Params:

Name	Type	Attribute	Description
taskId	string	nullable: false	identifier of operation

Return:

PeriodicityActions

public newProvisionProcessorsFinder(): ProvisionProcessorsFinder source

This return a util to find a provision procesor

Return:

ProvisionProcessorsFinder

public newRuleConfigurationsCatalog(): RuleConfigurationsCatalog source

This return a util to find Rule Configurations Templates

Return:

RuleConfigurationsCatalog

public newRuleConfigurationsFinder(): RuleConfigurationsFinder source

This return a util to find Rule Configurations

Return:

RuleConfigurationsFinder

public newRuleConfigurationsHelper(): * source

This return a util RuleConfigurationsHelper

Return:

*	{RuleConfigurationsHelper

public newScheduleHistoryFinder(): HistoryFinder source

This return a util to view schedule history

Return:

HistoryFinder

public newScheduleImageExecutionFinder(): ImageExecutionFinder source

This return a util to view schedule image executions

Return:

ImageExecutionFinder

public newSchedulePipelineFinder(): PipelineFinder source

This return a util to view schedule pipelines

Return:

PipelineFinder

public newScheduleRestRequestFinder(): RestRequestFinder source

This return a util to view schedule rest requests

Return:

RestRequestFinder

public newSelectBuilder(): SelectBuilder source

This return a util to create your own select to make searching

Return:

SelectBuilder

public newSoftwareFinder(): SoftwareFinder source

This return a util to find an organization software

Return:

SoftwareFinder

public newSubscribersFinder(): SubscribersFinder source

This return a util to find a Subscriber

Return:

SubscribersFinder

public newSubscriptionsFinder(): SubscriptionsFinder source

This return a util to find a Subscription

Return:

SubscriptionsFinder

public newTicketFinder(): TicketFinder source

This return a util to find a ticket

Return:

TicketFinder

public newTimeserieFinder(): TimeserieFinder source

This return a to find Timeserie configuration

Return:

TimeserieFinder

public newTimeseriesFunctionFinder(): TimeseriesFunctionsFinder source

This return a util to find a timeseries function

Return:

TimeseriesFunctionsFinder

public newTimeseriesFunctionsHelper(): TimeseriesFunctionsHelper source

This return a TimeseriesFunctionsHelper

Return:

TimeseriesFunctionsHelper

public newUserFinder(): UserFinder source

This return a util to find a user

Return:

UserFinder

public newWorkgroupFinder(): WorkgroupFinder source

This return a util to find a workgroup

Return:

WorkgroupFinder

public newWorkgroupRelationsFinder(): WorkgroupRelationsFinder source

This return a WorkgroupRelationsFinder

Return:

WorkgroupRelationsFinder

public notebookLauncherBuilder(): NotebookLauncherBuilder source

This return a NotebookLauncherBuilder to build a specific NotebookLauncherBuilder

Return:

NotebookLauncherBuilder

public notebookSchedulerBuilder(): NotebookSchedulerBuilder source

This return a NotebookSchedulerBuilder to build a specific NotebookSchedulerBuilder

Return:

NotebookSchedulerBuilder

public operationTypeBuilder(organization: , name: , operationTypeObj: *): OperationType source

This return a util to update an Operation Type

Params:

Name	Type	Attribute	Description
organization	*
name	*
operationTypeObj	*

Return:

OperationType

public operationTypesSearchBuilder(): OperationTypesSearchBuilder source

This return a OperationTypesSearchBuilder to build a specific OperationTypesSearch

Return:

OperationTypesSearchBuilder

public operationalStatusSearchBuilder(): OperationalStatusSearchBuilder source

This return a OperationalStatusSearchBuilder to build a specific OperationalStatusSearchBuilder

Return:

OperationalStatusSearchBuilder

public operationsSearchBuilder(): OperationsSearchBuilder source

This return a OperationsSearchBuilder to build a specific ExecutionssSearch

Return:

OperationsSearchBuilder

Test:

public organizationManufacturerModelsBuilder(organization: , manufacturerIdentifier: ): OrganizationManufacturerModelsBuilder source

This return a OrganizationManufacturerModelsBuilder to build a specific OrganizationManufacturerModelsBuilder

Params:

Name	Type	Attribute	Description
organization	*
manufacturerIdentifier	*

Return:

OrganizationManufacturerModelsBuilder

public organizationManufacturersBuilder(organization: *): OrganizationManufacturersBuilder source

This return a OrganizationManufacturersBuilder to build a specific OrganizationManufacturersBuilder

Params:

Name	Type	Attribute	Description
organization	*

Return:

OrganizationManufacturersBuilder

public organizationsBuilder(): Organizations source

This return a OrganizationsBuilder to build a specific OrganizationsBuilder

Return:

Organizations

public plansSearchBuilder(): PlansSearchBuilder source

This return a PlansSearchBuilder to build a specific PlansSearchBuilder

Return:

PlansSearchBuilder

public powerSupplyMessageBuilder(): PowerSupply source

Return:

PowerSupply

public provisionProcessorsBuilder(): provisionProcessorsBuilder source

This return a ProvisionsProcesorsBuilder to build a specific ProvisionsProcesorsBuilder

Return:

provisionProcessorsBuilder

public qratingsBuilder(): QratingsBuilder source

This return a Qrating to build a specific Qrating

Return:

QratingsBuilder

public rawSearchBuilder(): RawSearchBuilder source

Create custom search with custom url and raw filter

Return:

RawSearchBuilder

Test:

public resourceTypeSearchBuilder(): ResourceTypeSearchBuilder source

This return a ResourceTypeSearchBuilder to build a specific ResourceTypeSearchBuilder

Return:

ResourceTypeSearchBuilder

public ruleConfigurationBuilder(organization: , channel: , name: , ruleConfigObj: ): RuleConfigurations source

This return a util to update a Rule Configuration

Params:

Name	Type	Attribute	Description
organization	*
channel	*
name	*
ruleConfigObj	*

Return:

RuleConfigurations

public rulesSearchBuilder(): RulesSearchBuilder source

This return a RulesSearchBuilder to build a specific RulesSearch

Return:

RulesSearchBuilder

public scheduleImageExecutionBuilder(): ImageExecution source

This return a util to build schedule image executions

Return:

ImageExecution

public schedulePipelineBuilder(): SchedulePipeline source

This return a util to build a pipeline

Return:

SchedulePipeline

public scheduleRestRequestBuilder(): RestRequest source

This return a util to build schedule rest requests

Return:

RestRequest

public serviceGroupSearchBuilder(): ServiceGroupSearchBuilder source

This return a ServiceGroupSearchBuilder to build a specific ServiceGroupSearchBuilder

Return:

ServiceGroupSearchBuilder

public softwareMessageBuilder(): Software source

Return:

Software

public softwaresBuilder(organization: *): SoftwaresBuilder source

This return a SoftwaresBuilder to build a specific SoftwaresBuilder

Params:

Name	Type	Attribute	Description
organization	*

Return:

SoftwaresBuilder

public softwaresSearchBuilder(): SoftwaresSearchBuilder source

This return a SoftwaresSearchBuilder to build a specific SoftwaresSearchBuilder

Return:

SoftwaresSearchBuilder

public storageMessageBuilder(): Storage source

Return:

Storage

public subscriberMessageBuilder(): SubscriberMessage source

Return:

SubscriberMessage

public subscribersSearchBuilder(): SubscribersSearchBuilder source

This return a SubscribersSearchBuilder to build a specific DeviceSearch

Return:

SubscribersSearchBuilder

Test:

public subscriptionMessageBuilder(): SubscriptionMessage source

Return:

SubscriptionMessage

public subscriptionsSearchBuilder(): SubscriptionsSearchBuilder source

This return a SubscriptionsSearchBuilder to build a specific DeviceSearch

Return:

SubscriptionsSearchBuilder

Test:

public tasksSearchBuilder(): TasksSearchBuilder source

This return a TasksSearchBuilder to build a specific TasksSearch

Return:

TasksSearchBuilder

public ticketPrioritySearchBuilder(): TicketPrioritySearchBuilder source

This return a TicketPrioritySearchBuilder to build a specific TicketPrioritySearchBuilder

Return:

TicketPrioritySearchBuilder

public ticketSeveritySearchBuilder(): TicketSeveritySearchBuilder source

This return a TicketSeveritySearchBuilder to build a specific TicketSeveritySearchBuilder

Return:

TicketSeveritySearchBuilder

public ticketStatusSearchBuilder(): TicketStatusSearchBuilder source

This return a TicketStatusSearchBuilder to build a specific TicketStatusSearchBuilder

Return:

TicketStatusSearchBuilder

public ticketsSearchBuilder(): * source

This return a TicketsSearchBuilder to build a specific TicketSearch

Return:

public timeserieDatasetBuilder(organization: , timeserie: ): TimeserieDatasetBuilder source

This return a TimeserieDatasetBuilder to build a specific TimeserieDataset

Params:

Name	Type	Attribute	Description
organization	*
timeserie	*

Return:

TimeserieDatasetBuilder

public timeserieDownsamplerBuilder(organization: , timeserie: , entityId: *): TimeserieDownsamplerBuilder source

This return a TimeserieDownsamplerBuilder to build a specific TimeserieDownsampler

Params:

Name	Type	Attribute	Description
organization	*
timeserie	*
entityId	*

Return:

TimeserieDownsamplerBuilder

public timeserieSearchBuilder(organization: , timeserie: ): TimeserieSearchBuilder source

This return a TimeserieSearchBuilder to build a specific TimeserieSearch

Params:

Name	Type	Attribute	Description
organization	*
timeserie	*

Return:

TimeserieSearchBuilder

public timeseriesBuilder(): Timeseries source

This return a TimeserieBuilder to build a specific timeserie

Return:

Timeseries

public timeseriesFunctionBuilder(organization: , identifier: ): TimeseriesFunction source

This return a TimeserieBuilder to build a specific timeserie

Params:

Name	Type	Attribute	Description
organization	*
identifier	*

Return:

TimeseriesFunction

public timezoneSearchBuilder(): TimezoneSearchBuilder source

This return a TimezoneSearchBuilder to build a specific TimezoneSearchBuilder

Return:

TimezoneSearchBuilder

public usageMessageBuilder(): Usage source

Return:

Usage

public userLanguagesSearchBuilder(): UserLanguagesSearchBuilder source

This return a UserLanguagesSearchBuilder to build a specific UserLanguagesSearchBuilder

Return:

UserLanguagesSearchBuilder

public userProfilesSearchBuilder(): UserProfilesSearchBuilder source

This return a UserProfilesSearchBuilder to build a specific UserProfilesSearchBuilder

Return:

UserProfilesSearchBuilder

public usersBuilder(): User source

This return a util to create a user

Return:

User

public usersSearchBuilder(): UsersSearchBuilder source

This return a UsersSearchBuilder to build a specific UsersSearch

Return:

UsersSearchBuilder

public workgroupRelationsBuilder(): WorkgroupRelations source

This return a WorkgroupRelationsBuilder to build a specific workgroup relation

Return:

WorkgroupRelations

public workgroupsBuilder(): Workgroups source

This return a WorkgroupsBuilder to build a specific workgroup

Return:

Workgroups

public workgroupsSearchBuilder(): WorkgroupsSearchBuilder source

This return a WorkgroupsSearchBuilder to build a specific WorkgroupsSearch

Return:

WorkgroupsSearchBuilder

InternalOpenGateAPI

Test:

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor(_options: {url: string, port: string, version: string, apiKey: string}, ampliaREST: AmpliaREST) source

Params:

Public Members

public EX: * source

public Napi: * source

public SE: * source

public Sapi: * source

public alarms: * source

public entityBuilder: * source

public operations: * source

Public Methods

public administrativeStateSearchBuilder(): AdministrativeStateSearchBuilder source

Return:

public alarmsSearchBuilder(): AlarmsSearchBuilder source

Return:

Test:

public allowedResourceTypeSearchBuilder(): AllowedResourceTypeSearchBuilder source

Return:

public areasBuilder(): Areas source

Return:

public areasSearchBuilder(): AreasSearchBuilder source

Return:

public assetsSearchBuilder(): AssetsSearchBuilder source

Return:

public basicTypesSearchBuilder(): * source

Return:

public bulkExecutionBuilder(organization: *, processorId: *, timeout: *): BulkExecutionBuilder source

Params:

Return:

public bulkExecutionSearchBuilder(): BulkExecutionSearchBuilder source

Return:

public bulkSearchBuilder(): BulkSearchBuilder source

Return:

public bundlesBuilder(): Bundles source

Return:

Test:

public bundlesSearchBuilder(): BundlesSearchBuilder source

Return:

Test:

public certificatesBuilder(): Certificates source

Return:

Test:

public certificatesSearchBuilder(): CertificatesSearchBuilder source

Return:

public channelsBuilder(): Channels source

Return:

public channelsSearchBuilder(): ChannelsSearchBuilder source

Return:

public commsModuleMessageMessageBuilder(): CommsModuleMessage source

Return:

public communicationsModuleTypeSearchBuilder(): CommunicationsModuleTypeSearchBuilder source

Return:

public connectorFunctionsBuilder(organization: *, channel: *, identifier: *, connectorFunctionData: *): ConnectorFunctions source

Params:

Return:

public connectorFunctionsCatalogBuilder(identifier: String, connectorFunctionsCatalog: Object): ConnectorFunctionsCatalog source

Params:

Return:

public countryCodesSearchBuilder(): CountryCodesSearchBuilder source

Return:

public datamodelsBuilder(organization: *): Datamodels source

Params:

Return:

public datamodelsHelper(organization: *, datamodel: *): DatamodelsHelper source

Params:

Return:

public datamodelsSearchBuilder(): DatamodelsSearchBuilder source

Return:

public datapointsBuilder(): Datapoint source

Return:

public datapointsSearchBuilder(): DatapointsSearchBuilder source

Return:

Test:

public datasetEntitiesSearchBuilder(organization: *, dataset: *): DatasetEntitiesSearchBuilder source

public bulkExecutionBuilder(organization: , processorId: , timeout: *): BulkExecutionBuilder source

public connectorFunctionsBuilder(organization: , channel: , identifier: , connectorFunctionData: ): ConnectorFunctions source

public datamodelsHelper(organization: , datamodel: ): DatamodelsHelper source

public datasetEntitiesSearchBuilder(organization: , dataset: ): DatasetEntitiesSearchBuilder source

public datasetSearchBuilder(organization: , dataset: ): DatasetSearchBuilder source