This is an abstract class. It must be extended by another class that defines the backend, and it is used to make requests to the OpenGate North API from a browser or a Node.js server.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
_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.

administrativeStateSearchBuilder()

This returns a AdministrativeStateSearchBuilder to build a specific AdministrativeStateSearchBuilder

Retorna

Tip

Tipo: AdministrativeStateSearchBuilder

alarmsSearchBuilder()

This returns a AlarmsSearchBuilder to build a specific AlarmsSearch

Retorna

Tip

Tipo: AlarmsSearchBuilder

allowedResourceTypeSearchBuilder()

This returns a AllowedResourceTypeSearchBuilder to build a specific AllowedResourceTypeSearchBuilder

Retorna

Tip

Tipo: AllowedResourceTypeSearchBuilder

areasBuilder()

This returns a AreasBuilder to build a specific area

Retorna

Tip

Tipo: Areas

areasSearchBuilder()

This returns a AreasSearchBuilder to build a specific AreasSearch

Retorna

Tip

Tipo: AreasSearchBuilder

assetsSearchBuilder()

This returns a AssetsSearchBuilder to build a specific AssetSearch

Retorna

Tip

Tipo: AssetsSearchBuilder

bulkExecutionBuilder(organization, processorId, timeout)

This returns a util to create a bulk execution

Retorna

Tip

Tipo: BulkExecutionBuilder

bulkExecutionSearchBuilder()

This returns a BulkExecutionSearchBuilder to build a specific bulk

Retorna

Tip

Tipo: BulkExecutionSearchBuilder

bulkSearchBuilder()

This returns a BulkSearchBuilder to build a specific BulkSearchBuilder

Retorna

Tip

Tipo: BulkSearchBuilder

bundlesBuilder()

This returns a BundlesBuilder to build a specific BundlesBuilder

Retorna

Tip

Tipo: Bundles

bundlesSearchBuilder()

This returns a BundlesSearchBuilder to build a specific BundlesSearchBuilder

Retorna

Tip

Tipo: BundlesSearchBuilder

certificatesBuilder()

This returns a util to create a certificate

Retorna

Tip

Tipo: Certificates

certificatesSearchBuilder()

This returns a CertificatesSearchBuilder to build a specific CertificatesSearchBuilder

Retorna

Tip

Tipo: CertificatesSearchBuilder

channelsBuilder()

This returns a ChannelsBuilder to build a specific WorkgroupsSearch

Retorna

Tip

Tipo: Channels

channelsSearchBuilder()

This returns a ChannelsSearchBuilder to build a specific ChannelsSearch

Retorna

Tip

Tipo: ChannelsSearchBuilder

commsModuleMessageMessageBuilder()

Retorna

Tip

Tipo: CommsModuleMessage

communicationsModuleTypeSearchBuilder()

This returns a CommunicationsModuleTypeSearchBuilder to build a specific CommunicationsModuleTypeSearch

Retorna

Tip

Tipo: CommunicationsModuleTypeSearchBuilder

connectorFunctionsBuilder(organization, channel, identifier, connectorFunctionData)

This returns a ConnectorFunctions

Retorna

Tip

Tipo: ConnectorFunctions

connectorFunctionsCatalogBuilder(identifier, connectorFunctionsCatalog)

Parámetros

Nombre Tipo Opcional Descripción
identifier String ❌ only update or delete
connectorFunctionsCatalog Object ❌

Retorna

Tip

Tipo: ConnectorFunctionsCatalog

countryCodesSearchBuilder()

This returns a CountryCodesSearchBuilder to build a specific CountryCodesSearchBuilder

Retorna

Tip

Tipo: CountryCodesSearchBuilder

datamodelsBuilder(organization)

This returns a Datamodels to build a specific Datamodels

Retorna

Tip

Tipo: Datamodels

datamodelsHelper(organization, datamodel)

This returns a DatamodelsHelper to build a specific DatamodelsHelper

Retorna

Tip

Tipo: DatamodelsHelper

datamodelsSearchBuilder()

This returns a DatamodelsSearchBuilder to build a specific DatamodelsSearchBuilder

Retorna

Tip

Tipo: DatamodelsSearchBuilder

datapointsBuilder()

This returns a datapointsBuilder to build a specific Datapoint

Retorna

Tip

Tipo: Datapoint

datapointsSearchBuilder()

This returns a DatapointsSearchBuilder to build a specific DatapointsSearchBuilder

Retorna

Tip

Tipo: DatapointsSearchBuilder

datasetEntitiesSearchBuilder(organization, dataset)

This returns a DatasetEntitiesSearchBuilder to build a specific DatasetEntitiesSearch

Retorna

Tip

Tipo: DatasetEntitiesSearchBuilder

datasetsBuilder()

This returns a DatasetBuilder to build a specific dataset

Retorna

Tip

Tipo: Datasets

datasetsCatalogSearchBuilder()

This returns a DatasetsCatalogSearchBuilder to build a specific DatasetsCatalogSearc

Retorna

Tip

Tipo: DatasetsCatalogSearchBuilder

datasetSearchBuilder(organization, dataset)

This returns a DatasetSearchBuilder to build a specific DatasetSearch

Retorna

Tip

Tipo: DatasetSearchBuilder

datastreamBuilder()

This returns a datastreamBuilder to build a specific Datastream

Retorna

Tip

Tipo: Datastream

datastreamsBuilder()

This returns a datastream to build a specific Datastream

Retorna

Tip

Tipo: DatastreamsBuilder

datastreamsSearchBuilder()

This returns a DatastreamsSearchBuilder to build a specific DatastreamsSearchBuilder

Retorna

Tip

Tipo: DatastreamsSearchBuilder

deviceMessageBuilder()

This returns a DevicesSouth to build a specific DevicesSouth

Retorna

Tip

Tipo: DeviceMessage

devicePlansBuilder(organization)

This returns a DevicePlans to build a specific device plan

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌

Retorna

Tip

Tipo: OrganizationPlans

devicesSearchBuilder()

This returns a DevicesSearchBuilder to build a specific DeviceSearch

Retorna

Tip

Tipo: DevicesSearchBuilder

entitiesSearchBuilder()

This returns a EntitiesSearchBuilder to build a specific EntitiesSearch

Retorna

Tip

Tipo: EntitiesSearchBuilder

executionsHistorySearchBuilder()

This returns a ExecutionsHistorySearchBuilder to build a specific ExecutionsSearch

Retorna

Tip

Tipo: ExecutionsHistorySearchBuilder

executionsSearchBuilder()

This returns a ExecutionsSearchBuilder to build a specific ExecutionsSearch

Retorna

Tip

Tipo: ExecutionsSearchBuilder

feedsSearchBuilder()

This returns a FeedsSearchBuilder to build a specific FeedsSearchBuilder

Retorna

Tip

Tipo: FeedsSearchBuilder

fieldsDefinitionSearchBuilder()

This returns a FieldsDefinitionSearchBuilder to build a specific FieldsDefinitionSearchBuilder

Retorna

Tip

Tipo: FieldsDefinitionSearchBuilder

geoclusterBuilder()

This returns a util to regenerate geloclouster

Retorna

Tip

Tipo: Geocluster

hardwareMessageBuilder()

Retorna

Tip

Tipo: Hardware

ioTDatastreamAccessSearchBuilder()

This returns a IoTDatastreamAccessSearchBuilder to build a specific IoTDatastreamAccessSearchBuilder

Retorna

Tip

Tipo: IoTDatastreamAccessSearchBuilder

ioTDatastreamPeriodSearchBuilder()

This returns a IoTDatastreamPeriodSearchBuilder to build a specific IoTDatastreamPeriodSearchBuilder

Retorna

Tip

Tipo: IoTDatastreamPeriodSearchBuilder

ioTDatastreamStoragePeriodSearchBuilder()

This returns a IoTDatastreamStoragePeriodSearchBuilder to build a specific IoTDatastreamStoragePeriodSearchBuilder

Retorna

Tip

Tipo: IoTDatastreamStoragePeriodSearchBuilder

manufacturerModelsBuilder(manufacturerIdentifier)

This returns a ManufacturerModelsBuilder to build a specific ManufacturerModelsBuilder

Retorna

Tip

Tipo: ManufacturerModelsBuilder

manufacturersBuilder()

This returns a ManufacturersBuilder to build a specific ManufacturersBuilder

Retorna

Tip

Tipo: ManufacturersBuilder

mobileMessageMessageBuilder()

Retorna

Tip

Tipo: Mobile

mobilePhoneProviderSearchBuilder()

This returns a MobilePhoneProviderSearchBuilder to build a specific MobilePhoneProviderTypeSearch

Retorna

Tip

Tipo: MobilePhoneProviderSearchBuilder

newAreaFinder()

This returns a util to find a area

Retorna

Tip

Tipo: AreaFinder

newBulkExecutionFinder()

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

Retorna

Tip

Tipo: BulkFinder

newBulkFinder()

This returns a util to find and download a bulk

Retorna

Tip

Tipo: BulkFinder

newBundleFinder()

This returns a util to find a bundle

Retorna

Tip

Tipo: BundleFinder

newCertificateFinder(organization, channel, name)

This return a util to launch actions on a rule This return a util to find a certificate

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ organization name of the rule
channel string ❌ channel name of the rule
name string ❌ rule name

Retorna

Tip

Tipo: RuleConfigurationsActions

newChannelFinder()

This returns a util to find a channel

Retorna

Tip

Tipo: ChannelFinder

newConnectorFunctionsCatalog()

This returns a ConnectorFunctionsCatalog

Retorna

Tip

Tipo: ConnectorFunctionsCatalog

newConnectorFunctionsCatalogFinder()

This returns a ConnectorFunctionsCatalogFinder

Retorna

Tip

Tipo: ConnectorFunctionsCatalogFinder

newConnectorFunctionsFinder()

This returns a ConnectorFunctionsFinder

Retorna

Tip

Tipo: ConnectorFunctionsFinder

newConnectorFunctionsHelper()

This returns a ConnectorFunctionsHelper

Retorna

Tip

Tipo: ConnectorFunctionsHelper

newCountriesCatalog()

This returns a util to find countries catalog

Retorna

Tip

Tipo: CountriesCatalog

newDatamodelsFinder()

This returns a util to find a datamodel

Retorna

Tip

Tipo: DatamodelsFinder

newDatasetFinder()

This returns a to find Dataset configuration

Retorna

Tip

Tipo: DatasetFinder

newDeviceFinder()

This returns a util to find a device

Retorna

Tip

Tipo: DeviceFinder

newDevicePlansFinder()

This returns a util to find device plans

Retorna

Tip

Tipo: DevicePlansFinder

newDomainsFinder()

This returns a util to find a domains hierarchy

Retorna

Tip

Tipo: DomainsFinder

newFilterBuilder()

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

Retorna

Tip

Tipo: FilterBuilder

newGeoclusterFinder()

This returns a util to find a user

Retorna

Tip

Tipo: GeoclusterFinder

newManufacturersFinder()

This returns a util to find a hardware manufacturer

Retorna

Tip

Tipo: ManufacturerFinder

newModelFinder()

This returns a util to find a hardware model

Retorna

Tip

Tipo: ModelFinder

newNotebookFinder()

This returns a util to find notebooks

Retorna

Tip

Tipo: NotebookFinder

newNotebookSchedulerFinder()

This returns a util to find notebooks schedulers

Retorna

Tip

Tipo: NotebookSchedulerFinder

newOperationActions(operationId)

This returns a util to operation actions on an operation

Parámetros

Nombre Tipo Opcional Descripción
operationId string ❌ identifier of operation

Retorna

Tip

Tipo: OperationActions

newOperationFinder()

This returns a util to find a operation

Retorna

Tip

Tipo: OperationFinder

newOperationTypeCatalog()

This returns a util to find Operation Types Templates

Retorna

Tip

Tipo: OperationTypeCatalog

newOperationTypeFinder()

This returns a util to find Operation Types

Retorna

Tip

Tipo: OperationType

newOrganizationFinder()

This returns a util to find a organization

Retorna

Tip

Tipo: OrganizationFinder

newOrganizationManufacturersFinder()

This returns a util to find a hardware manufacturer

Retorna

Tip

Tipo: OrganizationManufacturerFinder

newOrganizationModelFinder()

This returns a util to find a hardware model

Retorna

Tip

Tipo: OrganizationModelFinder

newOrganizationPlansFinder()

This returns a util to find organization plans

Retorna

Tip

Tipo: OrganizationPlansFinder

newPeriodicityActions(taskId)

This returns a util to manage actions over periodicities

Parámetros

Nombre Tipo Opcional Descripción
taskId string ❌ identifier of operation

Retorna

Tip

Tipo: PeriodicityActions

newProvisionProcessorsFinder()

This returns a util to find a provision procesor

Retorna

Tip

Tipo: ProvisionProcessorsFinder

newRuleConfigurationsCatalog()

This returns a util to find Rule Configurations Templates

Retorna

Tip

Tipo: RuleConfigurationsCatalog

newRuleConfigurationsFinder()

This returns a util to find Rule Configurations

Retorna

Tip

Tipo: RuleConfigurationsFinder

newRuleConfigurationsHelper()

This returns a util RuleConfigurationsHelper

Retorna

Tip

Tipo: RuleConfigurationsHelper

newScheduleHistoryFinder()

This returns a util to view schedule history

Retorna

Tip

Tipo: HistoryFinder

newScheduleImageExecutionFinder()

This returns a util to view schedule image executions

Retorna

Tip

Tipo: ImageExecutionFinder

newSchedulePipelineFinder()

This returns a util to view schedule pipelines

Retorna

Tip

Tipo: PipelineFinder

newScheduleRestRequestFinder()

This returns a util to view schedule rest requests

Retorna

Tip

Tipo: RestRequestFinder

newSelectBuilder()

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

Retorna

Tip

Tipo: SelectBuilder

newSoftwareFinder()

This returns a util to find an organization software

Retorna

Tip

Tipo: SoftwareFinder

newSubscribersFinder()

This returns a util to find a Subscriber

Retorna

Tip

Tipo: SubscribersFinder

newSubscriptionsFinder()

This returns a util to find a Subscription

Retorna

Tip

Tipo: SubscriptionsFinder

newTicketFinder()

This returns a util to find a ticket

Retorna

Tip

Tipo: TicketFinder

newTimeserieFinder()

This returns a to find Timeserie configuration

Retorna

Tip

Tipo: TimeserieFinder

newTimeseriesFunctionFinder()

This returns a util to find a timeseries function

Retorna

Tip

Tipo: TimeseriesFunctionsFinder

newTimeseriesFunctionsHelper()

This returns a TimeseriesFunctionsHelper

Retorna

Tip

Tipo: TimeseriesFunctionsHelper

newUserFinder()

This returns a util to find a user

Retorna

Tip

Tipo: UserFinder

newWorkgroupFinder()

This returns a util to find a workgroup

Retorna

Tip

Tipo: WorkgroupFinder

newWorkgroupRelationsFinder()

This returns a WorkgroupRelationsFinder

Retorna

Tip

Tipo: WorkgroupRelationsFinder

notebookLauncherBuilder()

This returns a NotebookLauncherBuilder to build a specific NotebookLauncherBuilder

Retorna

Tip

Tipo: NotebookLauncherBuilder

notebookSchedulerBuilder()

This returns a NotebookSchedulerBuilder to build a specific NotebookSchedulerBuilder

Retorna

Tip

Tipo: NotebookSchedulerBuilder

operationalStatusSearchBuilder()

This returns a OperationalStatusSearchBuilder to build a specific OperationalStatusSearchBuilder

Retorna

Tip

Tipo: OperationalStatusSearchBuilder

operationsSearchBuilder()

This returns a OperationsSearchBuilder to build a specific ExecutionssSearch

Retorna

Tip

Tipo: OperationsSearchBuilder

operationTypeBuilder(organization, name, operationTypeObj)

This returns a util to update an Operation Type

Retorna

Tip

Tipo: OperationType

operationTypesSearchBuilder()

This returns a OperationTypesSearchBuilder to build a specific OperationTypesSearch

Retorna

Tip

Tipo: OperationTypesSearchBuilder

organizationManufacturerModelsBuilder(organization, manufacturerIdentifier)

This returns a OrganizationManufacturerModelsBuilder to build a specific OrganizationManufacturerModelsBuilder

Retorna

Tip

Tipo: OrganizationManufacturerModelsBuilder

organizationManufacturersBuilder(organization)

This returns a OrganizationManufacturersBuilder to build a specific OrganizationManufacturersBuilder

Retorna

Tip

Tipo: OrganizationManufacturersBuilder

organizationPlansBuilder(organization)

This returns a OrganizationPlans to build a specific organization plan

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌

Retorna

Tip

Tipo: OrganizationPlans

organizationsBuilder()

This returns a OrganizationsBuilder to build a specific OrganizationsBuilder

Retorna

Tip

Tipo: Organizations

organizationsSearchBuilder()

This returns a util to search organizations

Retorna

Tip

Tipo: OrganizationsSearchBuilder

powerSupplyMessageBuilder()

Retorna

Tip

Tipo: PowerSupply

provisionProcessorsBuilder()

This returns a ProvisionsProcesorsBuilder to build a specific ProvisionsProcesorsBuilder

Retorna

Tip

Tipo: provisionProcessorsBuilder

qratingsBuilder()

This returns a Qrating to build a specific Qrating

Retorna

Tip

Tipo: QratingsBuilder

rawSearchBuilder()

Create custom search with custom url and raw filter

Retorna

Tip

Tipo: RawSearchBuilder

resourceTypeSearchBuilder()

This returns a ResourceTypeSearchBuilder to build a specific ResourceTypeSearchBuilder

Retorna

Tip

Tipo: ResourceTypeSearchBuilder

ruleConfigurationBuilder(organization, channel, name, ruleConfigObj)

This returns a util to update a Rule Configuration

Retorna

Tip

Tipo: RuleConfigurations

rulesSearchBuilder()

This returns a RulesSearchBuilder to build a specific RulesSearch

Retorna

Tip

Tipo: RulesSearchBuilder

scheduleImageExecutionBuilder()

This returns a util to build schedule image executions

Retorna

Tip

Tipo: ImageExecution

schedulePipelineBuilder()

This returns a util to build a pipeline

Retorna

Tip

Tipo: SchedulePipeline

scheduleRestRequestBuilder()

This returns a util to build schedule rest requests

Retorna

Tip

Tipo: RestRequest

serviceGroupSearchBuilder()

This returns a ServiceGroupSearchBuilder to build a specific ServiceGroupSearchBuilder

Retorna

Tip

Tipo: ServiceGroupSearchBuilder

softwareMessageBuilder()

Retorna

Tip

Tipo: Software

softwaresBuilder(organization)

This returns a SoftwaresBuilder to build a specific SoftwaresBuilder

Retorna

Tip

Tipo: SoftwaresBuilder

softwaresSearchBuilder()

This returns a SoftwaresSearchBuilder to build a specific SoftwaresSearchBuilder

Retorna

Tip

Tipo: SoftwaresSearchBuilder

storageMessageBuilder()

Retorna

Tip

Tipo: Storage

subscriberMessageBuilder()

Retorna

Tip

Tipo: SubscriberMessage

subscribersSearchBuilder()

This returns a SubscribersSearchBuilder to build a specific DeviceSearch

Retorna

Tip

Tipo: SubscribersSearchBuilder

subscriptionMessageBuilder()

Retorna

Tip

Tipo: SubscriptionMessage

subscriptionsSearchBuilder()

This returns a SubscriptionsSearchBuilder to build a specific DeviceSearch

Retorna

Tip

Tipo: SubscriptionsSearchBuilder

tasksSearchBuilder()

This returns a TasksSearchBuilder to build a specific TasksSearch

Retorna

Tip

Tipo: TasksSearchBuilder

ticketPrioritySearchBuilder()

This returns a TicketPrioritySearchBuilder to build a specific TicketPrioritySearchBuilder

Retorna

Tip

Tipo: TicketPrioritySearchBuilder

ticketSeveritySearchBuilder()

This returns a TicketSeveritySearchBuilder to build a specific TicketSeveritySearchBuilder

Retorna

Tip

Tipo: TicketSeveritySearchBuilder

ticketsSearchBuilder()

This returns a TicketsSearchBuilder to build a specific TicketSearch

ticketStatusSearchBuilder()

This returns a TicketStatusSearchBuilder to build a specific TicketStatusSearchBuilder

Retorna

Tip

Tipo: TicketStatusSearchBuilder

timeserieDatasetBuilder(organization, timeserie)

This returns a TimeserieDatasetBuilder to build a specific TimeserieDataset

Retorna

Tip

Tipo: TimeserieDatasetBuilder

timeserieDownsamplerBuilder(organization, timeserie, entityId)

This returns a TimeserieDownsamplerBuilder to build a specific TimeserieDownsampler

Retorna

Tip

Tipo: TimeserieDownsamplerBuilder

timeseriesBuilder()

This returns a TimeserieBuilder to build a specific timeserie

Retorna

Tip

Tipo: Timeseries

timeserieSearchBuilder(organization, timeserie)

This returns a TimeserieSearchBuilder to build a specific TimeserieSearch

Retorna

Tip

Tipo: TimeserieSearchBuilder

timeseriesFunctionBuilder(organization, identifier)

This returns a TimeserieBuilder to build a specific timeserie

Retorna

Tip

Tipo: TimeseriesFunction

timezoneSearchBuilder()

This returns a TimezoneSearchBuilder to build a specific TimezoneSearchBuilder

Retorna

Tip

Tipo: TimezoneSearchBuilder

usageMessageBuilder()

Retorna

Tip

Tipo: Usage

userLanguagesSearchBuilder()

This returns a UserLanguagesSearchBuilder to build a specific UserLanguagesSearchBuilder

Retorna

Tip

Tipo: UserLanguagesSearchBuilder

userProfilesSearchBuilder()

This returns a UserProfilesSearchBuilder to build a specific UserProfilesSearchBuilder

Retorna

Tip

Tipo: UserProfilesSearchBuilder

usersBuilder()

This returns a util to create a user

Retorna

Tip

Tipo: User

usersSearchBuilder()

This returns a UsersSearchBuilder to build a specific UsersSearch

Retorna

Tip

Tipo: UsersSearchBuilder

workgroupRelationsBuilder()

This returns a WorkgroupRelationsBuilder to build a specific workgroup relation

Retorna

Tip

Tipo: WorkgroupRelations

workgroupsBuilder()

This returns a WorkgroupsBuilder to build a specific workgroup

Retorna

Tip

Tipo: Workgroups

workgroupsSearchBuilder()

This returns a WorkgroupsSearchBuilder to build a specific WorkgroupsSearch

Retorna

Tip

Tipo: WorkgroupsSearchBuilder