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

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 return a AdministrativeStateSearchBuilder to build a specific AdministrativeStateSearchBuilder

Retorna

Tip

Tipo: AdministrativeStateSearchBuilder

alarmsSearchBuilder()

This return a AlarmsSearchBuilder to build a specific AlarmsSearch

Retorna

Tip

Tipo: AlarmsSearchBuilder

allowedResourceTypeSearchBuilder()

This return a AllowedResourceTypeSearchBuilder to build a specific AllowedResourceTypeSearchBuilder

Retorna

Tip

Tipo: AllowedResourceTypeSearchBuilder

areasBuilder()

This return a AreasBuilder to build a specific area

Retorna

Tip

Tipo: Areas

areasSearchBuilder()

This return a AreasSearchBuilder to build a specific AreasSearch

Retorna

Tip

Tipo: AreasSearchBuilder

assetsSearchBuilder()

This return a AssetsSearchBuilder to build a specific AssetSearch

Retorna

Tip

Tipo: AssetsSearchBuilder

basicTypesSearchBuilder()

Retorna

Tip

Tipo: *

bulkExecutionBuilder(organization, processorId, timeout)

This return a util to create a bulk execution

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌
processorId * ❌
timeout * ❌

Retorna

Tip

Tipo: BulkExecutionBuilder

bulkExecutionSearchBuilder()

This return a BulkExecutionSearchBuilder to build a specific bulk

Retorna

Tip

Tipo: BulkExecutionSearchBuilder

bulkSearchBuilder()

This return a BulkSearchBuilder to build a specific BulkSearchBuilder

Retorna

Tip

Tipo: BulkSearchBuilder

bundlesBuilder()

This return a BundlesBuilder to build a specific BundlesBuilder

Retorna

Tip

Tipo: Bundles

bundlesSearchBuilder()

This return a BundlesSearchBuilder to build a specific BundlesSearchBuilder

Retorna

Tip

Tipo: BundlesSearchBuilder

certificatesBuilder()

This return a util to create a certificate

Retorna

Tip

Tipo: Certificates

certificatesSearchBuilder()

This return a CertificatesSearchBuilder to build a specific CertificatesSearchBuilder

Retorna

Tip

Tipo: CertificatesSearchBuilder

channelsBuilder()

This return a ChannelsBuilder to build a specific WorkgroupsSearch

Retorna

Tip

Tipo: Channels

channelsSearchBuilder()

This return a ChannelsSearchBuilder to build a specific ChannelsSearch

Retorna

Tip

Tipo: ChannelsSearchBuilder

commsModuleMessageMessageBuilder()

Retorna

Tip

Tipo: CommsModuleMessage

communicationsModuleTypeSearchBuilder()

This return a CommunicationsModuleTypeSearchBuilder to build a specific CommunicationsModuleTypeSearch

Retorna

Tip

Tipo: CommunicationsModuleTypeSearchBuilder

connectorFunctionsBuilder(organization, channel, identifier, connectorFunctionData)

This return a ConnectorFunctions

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌
channel * ❌
identifier * ❌
connectorFunctionData * ❌

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 return a CountryCodesSearchBuilder to build a specific CountryCodesSearchBuilder

Retorna

Tip

Tipo: CountryCodesSearchBuilder

datamodelsBuilder(organization)

This return a Datamodels to build a specific Datamodels

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌

Retorna

Tip

Tipo: Datamodels

datamodelsHelper(organization, datamodel)

This return a DatamodelsHelper to build a specific DatamodelsHelper

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌
datamodel * ❌

Retorna

Tip

Tipo: DatamodelsHelper

datamodelsSearchBuilder()

This return a DatamodelsSearchBuilder to build a specific DatamodelsSearchBuilder

Retorna

Tip

Tipo: DatamodelsSearchBuilder

datapointsBuilder()

This return a datapointsBuilder to build a specific Datapoint

Retorna

Tip

Tipo: Datapoint

datapointsSearchBuilder()

This return a DatapointsSearchBuilder to build a specific DatapointsSearchBuilder

Retorna

Tip

Tipo: DatapointsSearchBuilder

datasetEntitiesSearchBuilder(organization, dataset)

This return a DatasetEntitiesSearchBuilder to build a specific DatasetEntitiesSearch

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌
dataset * ❌

Retorna

Tip

Tipo: DatasetEntitiesSearchBuilder

datasetsBuilder()

This return a DatasetBuilder to build a specific dataset

Retorna

Tip

Tipo: Datasets

datasetsCatalogSearchBuilder()

This return a DatasetsCatalogSearchBuilder to build a specific DatasetsCatalogSearc

Retorna

Tip

Tipo: DatasetsCatalogSearchBuilder

datasetSearchBuilder(organization, dataset)

This return a DatasetSearchBuilder to build a specific DatasetSearch

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌
dataset * ❌

Retorna

Tip

Tipo: DatasetSearchBuilder

datastreamBuilder()

This return a datastreamBuilder to build a specific Datastream

Retorna

Tip

Tipo: Datastream

datastreamsBuilder()

This return a datastream to build a specific Datastream

Retorna

Tip

Tipo: DatastreamsBuilder

datastreamsSearchBuilder()

This return a DatastreamsSearchBuilder to build a specific DatastreamsSearchBuilder

Retorna

Tip

Tipo: DatastreamsSearchBuilder

deviceMessageBuilder()

This return a DevicesSouth to build a specific DevicesSouth

Retorna

Tip

Tipo: DeviceMessage

devicePlansBuilder(organization)

This return a DevicePlans to build a specific device plan

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌

Retorna

Tip

Tipo: OrganizationPlans

devicesSearchBuilder()

This return a DevicesSearchBuilder to build a specific DeviceSearch

Retorna

Tip

Tipo: DevicesSearchBuilder

entitiesSearchBuilder()

This return a EntitiesSearchBuilder to build a specific EntitiesSearch

Retorna

Tip

Tipo: EntitiesSearchBuilder

executionsHistorySearchBuilder()

This return a ExecutionsHistorySearchBuilder to build a specific ExecutionsSearch

Retorna

Tip

Tipo: ExecutionsHistorySearchBuilder

executionsSearchBuilder()

This return a ExecutionsSearchBuilder to build a specific ExecutionsSearch

Retorna

Tip

Tipo: ExecutionsSearchBuilder

feedsSearchBuilder()

This return a FeedsSearchBuilder to build a specific FeedsSearchBuilder

Retorna

Tip

Tipo: FeedsSearchBuilder

fieldsDefinitionSearchBuilder()

This return a FieldsDefinitionSearchBuilder to build a specific FieldsDefinitionSearchBuilder

Retorna

Tip

Tipo: FieldsDefinitionSearchBuilder

geoclusterBuilder()

This return a util to regenerate geloclouster

Retorna

Tip

Tipo: Geocluster

hardwareMessageBuilder()

Retorna

Tip

Tipo: Hardware

ioTDatastreamAccessSearchBuilder()

This return a IoTDatastreamAccessSearchBuilder to build a specific IoTDatastreamAccessSearchBuilder

Retorna

Tip

Tipo: IoTDatastreamAccessSearchBuilder

ioTDatastreamPeriodSearchBuilder()

This return a IoTDatastreamPeriodSearchBuilder to build a specific IoTDatastreamPeriodSearchBuilder

Retorna

Tip

Tipo: IoTDatastreamPeriodSearchBuilder

ioTDatastreamStoragePeriodSearchBuilder()

This return a IoTDatastreamStoragePeriodSearchBuilder to build a specific IoTDatastreamStoragePeriodSearchBuilder

Retorna

Tip

Tipo: IoTDatastreamStoragePeriodSearchBuilder

manufacturerModelsBuilder(manufacturerIdentifier)

This return a ManufacturerModelsBuilder to build a specific ManufacturerModelsBuilder

Parámetros

Nombre Tipo Opcional Descripción
manufacturerIdentifier * ❌

Retorna

Tip

Tipo: ManufacturerModelsBuilder

manufacturersBuilder()

This return a ManufacturersBuilder to build a specific ManufacturersBuilder

Retorna

Tip

Tipo: ManufacturersBuilder

mobileMessageMessageBuilder()

Retorna

Tip

Tipo: Mobile

mobilePhoneProviderSearchBuilder()

This return a MobilePhoneProviderSearchBuilder to build a specific MobilePhoneProviderTypeSearch

Retorna

Tip

Tipo: MobilePhoneProviderSearchBuilder

newAreaFinder()

This return a util to find a area

Retorna

Tip

Tipo: AreaFinder

newBulkExecutionFinder()

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

Retorna

Tip

Tipo: BulkFinder

newBulkFinder()

This return a util to find and download a bulk

Retorna

Tip

Tipo: BulkFinder

newBundleFinder()

This return a util to find a bundle

Retorna

Tip

Tipo: BundleFinder

newCertificateFinder()

This return a util to find a certificate

Retorna

Tip

Tipo: CertificateFinder

newChannelFinder()

This return a util to find a channel

Retorna

Tip

Tipo: ChannelFinder

newConnectorFunctionsCatalog()

This return a ConnectorFunctionsCatalog

Retorna

Tip

Tipo: ConnectorFunctionsCatalog

newConnectorFunctionsCatalogFinder()

This return a ConnectorFunctionsCatalogFinder

Retorna

Tip

Tipo: ConnectorFunctionsCatalogFinder

newConnectorFunctionsFinder()

This return a ConnectorFunctionsFinder

Retorna

Tip

Tipo: ConnectorFunctionsFinder

newConnectorFunctionsHelper()

This return a ConnectorFunctionsHelper

Retorna

Tip

Tipo: ConnectorFunctionsHelper

newCountriesCatalog()

This return a util to find countries catalog

Retorna

Tip

Tipo: CountriesCatalog

newDatamodelsFinder()

This return a util to find a datamodel

Retorna

Tip

Tipo: DatamodelsFinder

newDatasetFinder()

This return a to find Dataset configuration

Retorna

Tip

Tipo: DatasetFinder

newDeviceFinder()

This return a util to find a device

Retorna

Tip

Tipo: DeviceFinder

newDevicePlansFinder()

This return a util to find device plans

Retorna

Tip

Tipo: DevicePlansFinder

newDomainsFinder()

This return a util to find a domains hierarchy

Retorna

Tip

Tipo: DomainsFinder

newFilterBuilder()

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

Retorna

Tip

Tipo: FilterBuilder

newGeoclusterFinder()

This return a util to find a user

Retorna

Tip

Tipo: GeoclusterFinder

newManufacturersFinder()

This return a util to find a hardware manufacturer

Retorna

Tip

Tipo: ManufacturerFinder

newModelFinder()

This return a util to find a hardware model

Retorna

Tip

Tipo: ModelFinder

newNotebookFinder()

This return a util to find notebooks

Retorna

Tip

Tipo: NotebookFinder

newNotebookSchedulerFinder()

This return a util to find notebooks schedulers

Retorna

Tip

Tipo: NotebookSchedulerFinder

newOperationActions(operationId)

This return 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 return a util to find a operation

Retorna

Tip

Tipo: OperationFinder

newOperationTypeCatalog()

This return a util to find Operation Types Templates

Retorna

Tip

Tipo: OperationTypeCatalog

newOperationTypeFinder()

This return a util to find Operation Types

Retorna

Tip

Tipo: OperationType

newOrganizationFinder()

This return a util to find a organization

Retorna

Tip

Tipo: OrganizationFinder

newOrganizationManufacturersFinder()

This return a util to find a hardware manufacturer

Retorna

Tip

Tipo: OrganizationManufacturerFinder

newOrganizationModelFinder()

This return a util to find a hardware model

Retorna

Tip

Tipo: OrganizationModelFinder

newOrganizationPlansFinder()

This return a util to find organization plans

Retorna

Tip

Tipo: OrganizationPlansFinder

newPeriodicityActions(taskId)

This return 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 return a util to find a provision procesor

Retorna

Tip

Tipo: ProvisionProcessorsFinder

newRuleConfigurationsCatalog()

This return a util to find Rule Configurations Templates

Retorna

Tip

Tipo: RuleConfigurationsCatalog

newRuleConfigurationsFinder()

This return a util to find Rule Configurations

Retorna

Tip

Tipo: RuleConfigurationsFinder

newRuleConfigurationsHelper()

This return a util RuleConfigurationsHelper

Retorna

Tip

Tipo: *
{RuleConfigurationsHelper

newScheduleHistoryFinder()

This return a util to view schedule history

Retorna

Tip

Tipo: HistoryFinder

newScheduleImageExecutionFinder()

This return a util to view schedule image executions

Retorna

Tip

Tipo: ImageExecutionFinder

newSchedulePipelineFinder()

This return a util to view schedule pipelines

Retorna

Tip

Tipo: PipelineFinder

newScheduleRestRequestFinder()

This return a util to view schedule rest requests

Retorna

Tip

Tipo: RestRequestFinder

newSelectBuilder()

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

Retorna

Tip

Tipo: SelectBuilder

newSoftwareFinder()

This return a util to find an organization software

Retorna

Tip

Tipo: SoftwareFinder

newSubscribersFinder()

This return a util to find a Subscriber

Retorna

Tip

Tipo: SubscribersFinder

newSubscriptionsFinder()

This return a util to find a Subscription

Retorna

Tip

Tipo: SubscriptionsFinder

newTicketFinder()

This return a util to find a ticket

Retorna

Tip

Tipo: TicketFinder

newTimeserieFinder()

This return a to find Timeserie configuration

Retorna

Tip

Tipo: TimeserieFinder

newTimeseriesFunctionFinder()

This return a util to find a timeseries function

Retorna

Tip

Tipo: TimeseriesFunctionsFinder

newTimeseriesFunctionsHelper()

This return a TimeseriesFunctionsHelper

Retorna

Tip

Tipo: TimeseriesFunctionsHelper

newUserFinder()

This return a util to find a user

Retorna

Tip

Tipo: UserFinder

newWorkgroupFinder()

This return a util to find a workgroup

Retorna

Tip

Tipo: WorkgroupFinder

newWorkgroupRelationsFinder()

This return a WorkgroupRelationsFinder

Retorna

Tip

Tipo: WorkgroupRelationsFinder

notebookLauncherBuilder()

This return a NotebookLauncherBuilder to build a specific NotebookLauncherBuilder

Retorna

Tip

Tipo: NotebookLauncherBuilder

notebookSchedulerBuilder()

This return a NotebookSchedulerBuilder to build a specific NotebookSchedulerBuilder

Retorna

Tip

Tipo: NotebookSchedulerBuilder

operationalStatusSearchBuilder()

This return a OperationalStatusSearchBuilder to build a specific OperationalStatusSearchBuilder

Retorna

Tip

Tipo: OperationalStatusSearchBuilder

operationsSearchBuilder()

This return a OperationsSearchBuilder to build a specific ExecutionssSearch

Retorna

Tip

Tipo: OperationsSearchBuilder

operationTypeBuilder(organization, name, operationTypeObj)

This return a util to update an Operation Type

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌
name * ❌
operationTypeObj * ❌

Retorna

Tip

Tipo: OperationType

operationTypesSearchBuilder()

This return a OperationTypesSearchBuilder to build a specific OperationTypesSearch

Retorna

Tip

Tipo: OperationTypesSearchBuilder

organizationManufacturerModelsBuilder(organization, manufacturerIdentifier)

This return a OrganizationManufacturerModelsBuilder to build a specific OrganizationManufacturerModelsBuilder

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌
manufacturerIdentifier * ❌

Retorna

Tip

Tipo: OrganizationManufacturerModelsBuilder

organizationManufacturersBuilder(organization)

This return a OrganizationManufacturersBuilder to build a specific OrganizationManufacturersBuilder

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌

Retorna

Tip

Tipo: OrganizationManufacturersBuilder

organizationPlansBuilder(organization)

This return a OrganizationPlans to build a specific organization plan

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌

Retorna

Tip

Tipo: OrganizationPlans

organizationsBuilder()

This return a OrganizationsBuilder to build a specific OrganizationsBuilder

Retorna

Tip

Tipo: Organizations

organizationsSearchBuilder()

This return a util to search organizations

Retorna

Tip

Tipo: OrganizationsSearchBuilder

powerSupplyMessageBuilder()

Retorna

Tip

Tipo: PowerSupply

provisionProcessorsBuilder()

This return a ProvisionsProcesorsBuilder to build a specific ProvisionsProcesorsBuilder

Retorna

Tip

Tipo: provisionProcessorsBuilder

qratingsBuilder()

This return 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 return a ResourceTypeSearchBuilder to build a specific ResourceTypeSearchBuilder

Retorna

Tip

Tipo: ResourceTypeSearchBuilder

ruleConfigurationBuilder(organization, channel, name, ruleConfigObj)

This return a util to update a Rule Configuration

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌
channel * ❌
name * ❌
ruleConfigObj * ❌

Retorna

Tip

Tipo: RuleConfigurations

rulesSearchBuilder()

This return a RulesSearchBuilder to build a specific RulesSearch

Retorna

Tip

Tipo: RulesSearchBuilder

scheduleImageExecutionBuilder()

This return a util to build schedule image executions

Retorna

Tip

Tipo: ImageExecution

schedulePipelineBuilder()

This return a util to build a pipeline

Retorna

Tip

Tipo: SchedulePipeline

scheduleRestRequestBuilder()

This return a util to build schedule rest requests

Retorna

Tip

Tipo: RestRequest

serviceGroupSearchBuilder()

This return a ServiceGroupSearchBuilder to build a specific ServiceGroupSearchBuilder

Retorna

Tip

Tipo: ServiceGroupSearchBuilder

softwareMessageBuilder()

Retorna

Tip

Tipo: Software

softwaresBuilder(organization)

This return a SoftwaresBuilder to build a specific SoftwaresBuilder

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌

Retorna

Tip

Tipo: SoftwaresBuilder

softwaresSearchBuilder()

This return a SoftwaresSearchBuilder to build a specific SoftwaresSearchBuilder

Retorna

Tip

Tipo: SoftwaresSearchBuilder

storageMessageBuilder()

Retorna

Tip

Tipo: Storage

subscriberMessageBuilder()

Retorna

Tip

Tipo: SubscriberMessage

subscribersSearchBuilder()

This return a SubscribersSearchBuilder to build a specific DeviceSearch

Retorna

Tip

Tipo: SubscribersSearchBuilder

subscriptionMessageBuilder()

Retorna

Tip

Tipo: SubscriptionMessage

subscriptionsSearchBuilder()

This return a SubscriptionsSearchBuilder to build a specific DeviceSearch

Retorna

Tip

Tipo: SubscriptionsSearchBuilder

tasksSearchBuilder()

This return a TasksSearchBuilder to build a specific TasksSearch

Retorna

Tip

Tipo: TasksSearchBuilder

ticketPrioritySearchBuilder()

This return a TicketPrioritySearchBuilder to build a specific TicketPrioritySearchBuilder

Retorna

Tip

Tipo: TicketPrioritySearchBuilder

ticketSeveritySearchBuilder()

This return a TicketSeveritySearchBuilder to build a specific TicketSeveritySearchBuilder

Retorna

Tip

Tipo: TicketSeveritySearchBuilder

ticketsSearchBuilder()

This return a TicketsSearchBuilder to build a specific TicketSearch

Retorna

Tip

Tipo: *

ticketStatusSearchBuilder()

This return a TicketStatusSearchBuilder to build a specific TicketStatusSearchBuilder

Retorna

Tip

Tipo: TicketStatusSearchBuilder

timeserieDatasetBuilder(organization, timeserie)

This return a TimeserieDatasetBuilder to build a specific TimeserieDataset

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌
timeserie * ❌

Retorna

Tip

Tipo: TimeserieDatasetBuilder

timeserieDownsamplerBuilder(organization, timeserie, entityId)

This return a TimeserieDownsamplerBuilder to build a specific TimeserieDownsampler

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌
timeserie * ❌
entityId * ❌

Retorna

Tip

Tipo: TimeserieDownsamplerBuilder

timeseriesBuilder()

This return a TimeserieBuilder to build a specific timeserie

Retorna

Tip

Tipo: Timeseries

timeserieSearchBuilder(organization, timeserie)

This return a TimeserieSearchBuilder to build a specific TimeserieSearch

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌
timeserie * ❌

Retorna

Tip

Tipo: TimeserieSearchBuilder

timeseriesFunctionBuilder(organization, identifier)

This return a TimeserieBuilder to build a specific timeserie

Parámetros

Nombre Tipo Opcional Descripción
organization * ❌
identifier * ❌

Retorna

Tip

Tipo: TimeseriesFunction

timezoneSearchBuilder()

This return a TimezoneSearchBuilder to build a specific TimezoneSearchBuilder

Retorna

Tip

Tipo: TimezoneSearchBuilder

usageMessageBuilder()

Retorna

Tip

Tipo: Usage

userLanguagesSearchBuilder()

This return a UserLanguagesSearchBuilder to build a specific UserLanguagesSearchBuilder

Retorna

Tip

Tipo: UserLanguagesSearchBuilder

userProfilesSearchBuilder()

This return a UserProfilesSearchBuilder to build a specific UserProfilesSearchBuilder

Retorna

Tip

Tipo: UserProfilesSearchBuilder

usersBuilder()

This return a util to create a user

Retorna

Tip

Tipo: User

usersSearchBuilder()

This return a UsersSearchBuilder to build a specific UsersSearch

Retorna

Tip

Tipo: UsersSearchBuilder

workgroupRelationsBuilder()

This return a WorkgroupRelationsBuilder to build a specific workgroup relation

Retorna

Tip

Tipo: WorkgroupRelations

workgroupsBuilder()

This return a WorkgroupsBuilder to build a specific workgroup

Retorna

Tip

Tipo: Workgroups

workgroupsSearchBuilder()

This return a WorkgroupsSearchBuilder to build a specific WorkgroupsSearch

Retorna

Tip

Tipo: WorkgroupsSearchBuilder