Internal Open Gate API

InternalOpenGateAPI

InternalOpenGateAPI Objects

class 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

constructor

function constructor()

Constructor

Arguments:

• _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

function administrativeStateSearchBuilder() -> 'AdministrativeStateSearchBuilder'

This return a AdministrativeStateSearchBuilder to build a specific AdministrativeStateSearchBuilder

Returns:

• AdministrativeStateSearchBuilder(./searching/builder/AdministrativeStateSearchBuilder)

alarms

function alarms()

alarmsSearchBuilder

function alarmsSearchBuilder() -> 'AlarmsSearchBuilder'

This return a AlarmsSearchBuilder to build a specific AlarmsSearch

Returns:

• AlarmsSearchBuilder(./searching/builder/AlarmsSearchBuilder)

allowedResourceTypeSearchBuilder

function allowedResourceTypeSearchBuilder() -> 'AllowedResourceTypeSearchBuilder'

This return a AllowedResourceTypeSearchBuilder to build a specific AllowedResourceTypeSearchBuilder

Returns:

• AllowedResourceTypeSearchBuilder(./searching/builder/AllowedResourceTypeSearchBuilder)

areasBuilder

function areasBuilder() -> 'Areas'

This return a AreasBuilder to build a specific area

Returns:

• Areas(./areas/Areas)

areasSearchBuilder

function areasSearchBuilder() -> 'AreasSearchBuilder'

This return a AreasSearchBuilder to build a specific AreasSearch

Returns:

• AreasSearchBuilder(./searching/builder/AreasSearchBuilder)

assetsSearchBuilder

function assetsSearchBuilder() -> 'AssetsSearchBuilder'

This return a AssetsSearchBuilder to build a specific AssetSearch

Returns:

• AssetsSearchBuilder(./searching/builder/AssetsSearchBuilder)

basicTypesSearchBuilder

function basicTypesSearchBuilder() -> '*'

Returns:

• *

bulkExecutionBuilder

function bulkExecutionBuilder(organization: *,processorId: *,timeout: *) -> 'BulkExecutionBuilder'

This return a util to create a bulk execution

Arguments:

• organization *
• processorId *
• timeout *

Returns:

• BulkExecutionBuilder(./provision/bulk/BulkExecutionBuilder)

bulkExecutionSearchBuilder

function bulkExecutionSearchBuilder() -> 'BulkExecutionSearchBuilder'

This return a BulkExecutionSearchBuilder to build a specific bulk

Returns:

• BulkExecutionSearchBuilder(./searching/builder/BulkExecutionSearchBuilder)

bulkSearchBuilder

function bulkSearchBuilder() -> 'BulkSearchBuilder'

This return a BulkSearchBuilder to build a specific BulkSearchBuilder

Returns:

• BulkSearchBuilder(./searching/builder/BulkSearchBuilder)

bundlesBuilder

function bundlesBuilder() -> 'Bundles'

This return a BundlesBuilder to build a specific BundlesBuilder

Returns:

• Bundles(./bundles/Bundles)

bundlesSearchBuilder

function bundlesSearchBuilder() -> 'BundlesSearchBuilder'

This return a BundlesSearchBuilder to build a specific BundlesSearchBuilder

Returns:

• BundlesSearchBuilder(./searching/builder/BundlesSearchBuilder)

certificatesBuilder

function certificatesBuilder() -> 'Certificates'

This return a util to create a certificate

Returns:

• Certificates(./security/Certificates)

certificatesSearchBuilder

function certificatesSearchBuilder() -> 'CertificatesSearchBuilder'

This return a CertificatesSearchBuilder to build a specific CertificatesSearchBuilder

Returns:

• CertificatesSearchBuilder(./searching/builder/CertificatesSearchBuilder)

channelsBuilder

function channelsBuilder() -> 'Channels'

This return a ChannelsBuilder to build a specific WorkgroupsSearch

Returns:

• Channels(./channels/Channels)

channelsSearchBuilder

function channelsSearchBuilder() -> 'ChannelsSearchBuilder'

This return a ChannelsSearchBuilder to build a specific ChannelsSearch

Returns:

• ChannelsSearchBuilder(./searching/builder/ChannelsSearchBuilder)

commsModuleMessageMessageBuilder

function commsModuleMessageMessageBuilder() -> 'CommsModuleMessage'

Returns:

• CommsModuleMessage(./collection/devices/collect/CommsModuleMessage)

communicationsModuleTypeSearchBuilder

function communicationsModuleTypeSearchBuilder() -> 'CommunicationsModuleTypeSearchBuilder'

This return a CommunicationsModuleTypeSearchBuilder to build a specific CommunicationsModuleTypeSearch

Returns:

• CommunicationsModuleTypeSearchBuilder(./searching/builder/CommunicationsModuleTypeSearchBuilder)

connectorFunctionsBuilder

function connectorFunctionsBuilder(organization: *,channel: *,identifier: *,connectorFunctionData: *) -> 'ConnectorFunctions'

This return a ConnectorFunctions

Arguments:

• organization *
• channel *
• identifier *
• connectorFunctionData *

Returns:

• ConnectorFunctions(./connectorsFunctions/configuration/ConnectorFunctions)

connectorFunctionsCatalogBuilder

function connectorFunctionsCatalogBuilder(identifier: String,connectorFunctionsCatalog: Object) -> 'ConnectorFunctionsCatalog'

Arguments:

• identifier String - only update or delete
• connectorFunctionsCatalog Object

Returns:

• ConnectorFunctionsCatalog(./connectorsFunctions/catalog/ConnectorFunctionsCatalog)

countryCodesSearchBuilder

function countryCodesSearchBuilder() -> 'CountryCodesSearchBuilder'

This return a CountryCodesSearchBuilder to build a specific CountryCodesSearchBuilder

Returns:

• CountryCodesSearchBuilder(./searching/builder/CountryCodesSearchBuilder)

datamodelsBuilder

function datamodelsBuilder(organization: *) -> 'Datamodels'

This return a Datamodels to build a specific Datamodels

Arguments:

• organization *

Returns:

• Datamodels(./iot/datamodels/Datamodels)

datamodelsHelper

function datamodelsHelper(organization: *,datamodel: *) -> 'DatamodelsHelper'

This return a DatamodelsHelper to build a specific DatamodelsHelper

Arguments:

• organization *
• datamodel *

Returns:

• DatamodelsHelper(./iot/datamodels/DatamodelsHelper)

datamodelsSearchBuilder

function datamodelsSearchBuilder() -> 'DatamodelsSearchBuilder'

This return a DatamodelsSearchBuilder to build a specific DatamodelsSearchBuilder

Returns:

• DatamodelsSearchBuilder(./searching/builder/DatamodelsSearchBuilder)

datapointsBuilder

function datapointsBuilder() -> 'Datapoint'

This return a datapointsBuilder to build a specific Datapoint

Returns:

• Datapoint(./collection/devices/collect/Datapoint)

datapointsSearchBuilder

function datapointsSearchBuilder() -> 'DatapointsSearchBuilder'

This return a DatapointsSearchBuilder to build a specific DatapointsSearchBuilder

Returns:

• DatapointsSearchBuilder(./searching/builder/DatapointsSearchBuilder)

datasetEntitiesSearchBuilder

function datasetEntitiesSearchBuilder(organization: *,dataset: *) -> 'DatasetEntitiesSearchBuilder'

This return a DatasetEntitiesSearchBuilder to build a specific DatasetEntitiesSearch

Arguments:

• organization *
• dataset *

Returns:

• DatasetEntitiesSearchBuilder(./searching/builder/DatasetEntitiesSearchBuilder)

datasetsBuilder

function datasetsBuilder() -> 'Datasets'

This return a DatasetBuilder to build a specific dataset

Returns:

• Datasets(./datasets/Datasets)

datasetsCatalogSearchBuilder

function datasetsCatalogSearchBuilder() -> 'DatasetsCatalogSearchBuilder'

This return a DatasetsCatalogSearchBuilder to build a specific DatasetsCatalogSearc

Returns:

• DatasetsCatalogSearchBuilder(./searching/builder/DatasetsCatalogSearchBuilder)

datasetSearchBuilder

function datasetSearchBuilder(organization: *,dataset: *) -> 'DatasetSearchBuilder'

This return a DatasetSearchBuilder to build a specific DatasetSearch

Arguments:

• organization *
• dataset *

Returns:

• DatasetSearchBuilder(./searching/builder/DatasetSearchBuilder)

datastreamBuilder

function datastreamBuilder() -> 'Datastream'

This return a datastreamBuilder to build a specific Datastream

Returns:

• Datastream(./iot/catalog/Datastream)

datastreamsBuilder

function datastreamsBuilder() -> 'DatastreamsBuilder'

This return a datastream to build a specific Datastream

Returns:

• DatastreamsBuilder

datastreamsSearchBuilder

function datastreamsSearchBuilder() -> 'DatastreamsSearchBuilder'

This return a DatastreamsSearchBuilder to build a specific DatastreamsSearchBuilder

Returns:

• DatastreamsSearchBuilder(./searching/builder/DatastreamsSearchBuilder)

deviceMessageBuilder

function deviceMessageBuilder() -> 'DeviceMessage'

This return a DevicesSouth to build a specific DevicesSouth

Returns:

• DeviceMessage(./collection/devices/DeviceMessage)

devicesPlansSearchBuilder

function devicesPlansSearchBuilder() -> 'PlansSearchBuilder'

This return a DevicePlansSearchBuilder to build a specific DevicePlansSearchBuilder

Returns:

• PlansSearchBuilder(./searching/builder/PlansSearchBuilder)

devicesSearchBuilder

function devicesSearchBuilder() -> 'DevicesSearchBuilder'

This return a DevicesSearchBuilder to build a specific DeviceSearch

Returns:

• DevicesSearchBuilder(./searching/builder/DevicesSearchBuilder)

domainsBuilder

function domainsBuilder() -> 'Domain'

This return a DomainsBuilder to build a specific DomainsBuilder

Returns:

• Domain

domainsSearchBuilder

function domainsSearchBuilder() -> 'DomainsSearchBuilder'

This return a DomainsSearchBuilder to build a specific DomainsSearch

Returns:

• DomainsSearchBuilder(./searching/builder/DomainsSearchBuilder)

entitiesSearchBuilder

function entitiesSearchBuilder() -> 'EntitiesSearchBuilder'

This return a EntitiesSearchBuilder to build a specific EntitiesSearch

Returns:

• EntitiesSearchBuilder(./searching/builder/EntitiesSearchBuilder)

entityBuilder

function entityBuilder()

EX

function EX()

executionsHistorySearchBuilder

function executionsHistorySearchBuilder() -> 'ExecutionsHistorySearchBuilder'

This return a ExecutionsHistorySearchBuilder to build a specific ExecutionsSearch

Returns:

• ExecutionsHistorySearchBuilder(./searching/builder/ExecutionsHistorySearchBuilder)

executionsSearchBuilder

function executionsSearchBuilder() -> 'ExecutionsSearchBuilder'

This return a ExecutionsSearchBuilder to build a specific ExecutionsSearch

Returns:

• ExecutionsSearchBuilder(./searching/builder/ExecutionsSearchBuilder)

feedsSearchBuilder

function feedsSearchBuilder() -> 'FeedsSearchBuilder'

This return a FeedsSearchBuilder to build a specific FeedsSearchBuilder

Returns:

• FeedsSearchBuilder(./searching/builder/FeedsSearchBuilder)

fieldsDefinitionSearchBuilder

function fieldsDefinitionSearchBuilder() -> 'FieldsDefinitionSearchBuilder'

This return a FieldsDefinitionSearchBuilder to build a specific FieldsDefinitionSearchBuilder

Returns:

• FieldsDefinitionSearchBuilder(./searching/builder/FieldsDefinitionSearchBuilder)

geoclusterBuilder

function geoclusterBuilder() -> 'Geocluster'

This return a util to regenerate geloclouster

Returns:

• Geocluster(./geocluster/Geocluster)

hardwareMessageBuilder

function hardwareMessageBuilder() -> 'Hardware'

Returns:

• Hardware(./collection/devices/collect/Hardware)

ioTDatastreamAccessSearchBuilder

function ioTDatastreamAccessSearchBuilder() -> 'IoTDatastreamAccessSearchBuilder'

This return a IoTDatastreamAccessSearchBuilder to build a specific IoTDatastreamAccessSearchBuilder

Returns:

• IoTDatastreamAccessSearchBuilder(./searching/builder/IoTDatastreamAccessSearchBuilder)

ioTDatastreamPeriodSearchBuilder

function ioTDatastreamPeriodSearchBuilder() -> 'IoTDatastreamPeriodSearchBuilder'

This return a IoTDatastreamPeriodSearchBuilder to build a specific IoTDatastreamPeriodSearchBuilder

Returns:

• IoTDatastreamPeriodSearchBuilder(./searching/builder/IoTDatastreamPeriodSearchBuilder)

ioTDatastreamStoragePeriodSearchBuilder

function ioTDatastreamStoragePeriodSearchBuilder() -> 'IoTDatastreamStoragePeriodSearchBuilder'

This return a IoTDatastreamStoragePeriodSearchBuilder to build a specific IoTDatastreamStoragePeriodSearchBuilder

Returns:

• IoTDatastreamStoragePeriodSearchBuilder(./searching/builder/IoTDatastreamStoragePeriodSearchBuilder)

manufacturerModelsBuilder

function manufacturerModelsBuilder(manufacturerIdentifier: *) -> 'ManufacturerModelsBuilder'

This return a ManufacturerModelsBuilder to build a specific ManufacturerModelsBuilder

Arguments:

• manufacturerIdentifier *

Returns:

• ManufacturerModelsBuilder

manufacturersBuilder

function manufacturersBuilder() -> 'ManufacturersBuilder'

This return a ManufacturersBuilder to build a specific ManufacturersBuilder

Returns:

• ManufacturersBuilder

mobileMessageMessageBuilder

function mobileMessageMessageBuilder() -> 'Mobile'

Returns:

• Mobile(./collection/devices/collect/Mobile)

mobilePhoneProviderSearchBuilder

function mobilePhoneProviderSearchBuilder() -> 'MobilePhoneProviderSearchBuilder'

This return a MobilePhoneProviderSearchBuilder to build a specific MobilePhoneProviderTypeSearch

Returns:

• MobilePhoneProviderSearchBuilder(./searching/builder/MobilePhoneProviderSearchBuilder)

Napi

function Napi()

newAreaFinder

function newAreaFinder() -> 'AreaFinder'

This return a util to find a area

Returns:

• AreaFinder(./areas/AreaFinder)

newBulkExecutionFinder

function newBulkExecutionFinder() -> 'BulkFinder'

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

Returns:

• BulkFinder(./bulk/BulkFinder)

newBulkFinder

function newBulkFinder() -> 'BulkFinder'

This return a util to find and download a bulk

Returns:

• BulkFinder(./bulk/BulkFinder)

newBundleFinder

function newBundleFinder() -> 'BundleFinder'

This return a util to find a bundle

Returns:

• BundleFinder(./bundles/BundleFinder)

newCertificateFinder

function newCertificateFinder() -> 'CertificateFinder'

This return a util to find a certificate

Returns:

• CertificateFinder(./security/CertificateFinder)

newChannelFinder

function newChannelFinder() -> 'ChannelFinder'

This return a util to find a channel

Returns:

• ChannelFinder(./channels/ChannelFinder)

newConnectorFunctionsCatalog

function newConnectorFunctionsCatalog() -> 'ConnectorFunctionsCatalog'

This return a ConnectorFunctionsCatalog

Returns:

• ConnectorFunctionsCatalog(./connectorsFunctions/catalog/ConnectorFunctionsCatalog)

newConnectorFunctionsCatalogFinder

function newConnectorFunctionsCatalogFinder() -> 'ConnectorFunctionsCatalogFinder'

This return a ConnectorFunctionsCatalogFinder

Returns:

• ConnectorFunctionsCatalogFinder(./connectorsFunctions/catalog/ConnectorFunctionsCatalogFinder)

newConnectorFunctionsFinder

function newConnectorFunctionsFinder() -> 'ConnectorFunctionsFinder'

This return a ConnectorFunctionsFinder

Returns:

• ConnectorFunctionsFinder(./connectorsFunctions/configuration/ConnectorFunctionsFinder)

newConnectorFunctionsHelper

function newConnectorFunctionsHelper() -> 'ConnectorFunctionsHelper'

This return a ConnectorFunctionsHelper

Returns:

• ConnectorFunctionsHelper(./connectorsFunctions/configuration/ConnectorFunctionsHelper)

newCountriesCatalog

function newCountriesCatalog() -> 'CountriesCatalog'

This return a util to find countries catalog

Returns:

• CountriesCatalog(./provision/country/CountriesCatalog)

newDatamodelsFinder

function newDatamodelsFinder() -> 'DatamodelsFinder'

This return a util to find a datamodel

Returns:

• DatamodelsFinder(./iot/datamodels/DatamodelsFinder)

newDatasetFinder

function newDatasetFinder() -> 'DatasetFinder'

This return a to find Dataset configuration

Returns:

• DatasetFinder

newDeviceFinder

function newDeviceFinder() -> 'DeviceFinder'

This return a util to find a device

Returns:

• DeviceFinder(./entities/DeviceFinder)

newDomainFinder

function newDomainFinder() -> 'DomainFinder'

This return a util to find a domain

Returns:

• DomainFinder(./domains/DomainsFinder)

newEntityFinder

function newEntityFinder() -> '*'

Returns:

• *

newFilterBuilder

function newFilterBuilder() -> 'FilterBuilder'

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

Returns:

• FilterBuilder(./searching/FilterBuilder)

newGeoclusterFinder

function newGeoclusterFinder() -> 'GeoclusterFinder'

This return a util to find a user

Returns:

• GeoclusterFinder(./geocluster/GeoclusterFinder)

newManufacturersFinder

function newManufacturersFinder() -> 'ManufacturerFinder'

This return a util to find a hardware manufacturer

Returns:

• ManufacturerFinder(./organization_manufacturer/ManufacturerFinder)

newModelFinder

function newModelFinder() -> 'ModelFinder'

This return a util to find a hardware model

Returns:

• ModelFinder(./organization_manufacturer/ModelFinder)

newNotebookFinder

function newNotebookFinder() -> 'NotebookFinder'

This return a util to find notebooks

Returns:

• NotebookFinder(./notebookScheduler/NotebookFinder)

newNotebookSchedulerFinder

function newNotebookSchedulerFinder() -> 'NotebookSchedulerFinder'

This return a util to find notebooks schedulers

Returns:

• NotebookSchedulerFinder

newOperationActions

function newOperationActions(operationId: string) -> 'OperationActions'

This return a util to operation actions on an operation

Arguments:

• operationId string - identifier of operation

Returns:

• OperationActions(./operations/OperationActions)

newOperationFinder

function newOperationFinder() -> 'OperationFinder'

This return a util to find a operation

Returns:

• OperationFinder(./operations/OperationFinder)

newOperationTypeCatalog

function newOperationTypeCatalog() -> 'OperationTypeCatalog'

This return a util to find Operation Types Templates

Returns:

• OperationTypeCatalog

newOperationTypeFinder

function newOperationTypeFinder() -> 'OperationType'

This return a util to find Operation Types

Returns:

• OperationType(./operationTypes/OperationType)

newOrganizationFinder

function newOrganizationFinder() -> 'OrganizationFinder'

This return a util to find a organization

Returns:

• OrganizationFinder(./organizations/OrganizationFinder)

newOrganizationManufacturersFinder

function newOrganizationManufacturersFinder() -> 'OrganizationManufacturerFinder'

This return a util to find a hardware manufacturer

Returns:

• OrganizationManufacturerFinder

newOrganizationModelFinder

function newOrganizationModelFinder() -> 'OrganizationModelFinder'

This return a util to find a hardware model

Returns:

• OrganizationModelFinder

newPeriodicityActions

function newPeriodicityActions(taskId: string) -> 'PeriodicityActions'

This return a util to manage actions over periodicities

Arguments:

• taskId string - identifier of operation

Returns:

• PeriodicityActions(./operations/PeriodicityActions)

newProvisionProcessorsFinder

function newProvisionProcessorsFinder() -> 'ProvisionProcessorsFinder'

This return a util to find a provision procesor

Returns:

• ProvisionProcessorsFinder

newRuleConfigurationsCatalog

function newRuleConfigurationsCatalog() -> 'RuleConfigurationsCatalog'

This return a util to find Rule Configurations Templates

Returns:

• RuleConfigurationsCatalog(./rulesConfiguration/RuleConfigurationsCatalog)

newRuleConfigurationsFinder

function newRuleConfigurationsFinder() -> 'RuleConfigurationsFinder'

This return a util to find Rule Configurations

Returns:

• RuleConfigurationsFinder(./rulesConfiguration/RuleConfigurationsFinder)

newRuleConfigurationsHelper

function newRuleConfigurationsHelper() -> '*'

This return a util RuleConfigurationsHelper

Returns:

• * - {RuleConfigurationsHelper

newScheduleHistoryFinder

function newScheduleHistoryFinder() -> 'HistoryFinder'

This return a util to view schedule history

Returns:

• HistoryFinder(./schedule/HistoryFinder)

newScheduleImageExecutionFinder

function newScheduleImageExecutionFinder() -> 'ImageExecutionFinder'

This return a util to view schedule image executions

Returns:

• ImageExecutionFinder(./schedule/ImageExecutionFinder)

newSchedulePipelineFinder

function newSchedulePipelineFinder() -> 'PipelineFinder'

This return a util to view schedule pipelines

Returns:

• PipelineFinder(./schedule/PipelineFinder)

newScheduleRestRequestFinder

function newScheduleRestRequestFinder() -> 'RestRequestFinder'

This return a util to view schedule rest requests

Returns:

• RestRequestFinder(./schedule/RestRequestFinder)

newSelectBuilder

function newSelectBuilder() -> 'SelectBuilder'

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

Returns:

• SelectBuilder(./searching/SelectBuilder)

newSoftwareFinder

function newSoftwareFinder() -> 'SoftwareFinder'

This return a util to find an organization software

Returns:

• SoftwareFinder(./organization_software/SoftwareFinder)

newSubscribersFinder

function newSubscribersFinder() -> 'SubscribersFinder'

This return a util to find a Subscriber

Returns:

• SubscribersFinder(./entities/SubscribersFinder)

newSubscriptionsFinder

function newSubscriptionsFinder() -> 'SubscriptionsFinder'

This return a util to find a Subscription

Returns:

• SubscriptionsFinder(./entities/SubscriptionsFinder)

newTicketFinder

function newTicketFinder() -> 'TicketFinder'

This return a util to find a ticket

Returns:

• TicketFinder(./entities/TicketFinder)

newTimeserieFinder

function newTimeserieFinder() -> 'TimeserieFinder'

This return a to find Timeserie configuration

Returns:

• TimeserieFinder

newTimeseriesFunctionFinder

function newTimeseriesFunctionFinder() -> 'TimeseriesFunctionsFinder'

This return a util to find a timeseries function

Returns:

• TimeseriesFunctionsFinder

newTimeseriesFunctionsHelper

function newTimeseriesFunctionsHelper() -> 'TimeseriesFunctionsHelper'

This return a TimeseriesFunctionsHelper

Returns:

• TimeseriesFunctionsHelper(./timeseriesFunctionsCatalog/TimeseriesFunctionsHelper)

newUserFinder

function newUserFinder() -> 'UserFinder'

This return a util to find a user

Returns:

• UserFinder(./users/UserFinder)

newWorkgroupFinder

function newWorkgroupFinder() -> 'WorkgroupFinder'

This return a util to find a workgroup

Returns:

• WorkgroupFinder(./workgroups/WorkgroupFinder)

newWorkgroupRelationsFinder

function newWorkgroupRelationsFinder() -> 'WorkgroupRelationsFinder'

This return a WorkgroupRelationsFinder

Returns:

• WorkgroupRelationsFinder(./workgroups/WorkgroupRelationsFinder)

notebookLauncherBuilder

function notebookLauncherBuilder() -> 'NotebookLauncherBuilder'

This return a NotebookLauncherBuilder to build a specific NotebookLauncherBuilder

Returns:

• NotebookLauncherBuilder

notebookSchedulerBuilder

function notebookSchedulerBuilder() -> 'NotebookSchedulerBuilder'

This return a NotebookSchedulerBuilder to build a specific NotebookSchedulerBuilder

Returns:

• NotebookSchedulerBuilder

operationalStatusSearchBuilder

function operationalStatusSearchBuilder() -> 'OperationalStatusSearchBuilder'

This return a OperationalStatusSearchBuilder to build a specific OperationalStatusSearchBuilder

Returns:

• OperationalStatusSearchBuilder(./searching/builder/OperationalStatusSearchBuilder)

operations

function operations()

operationsSearchBuilder

function operationsSearchBuilder() -> 'OperationsSearchBuilder'

This return a OperationsSearchBuilder to build a specific ExecutionssSearch

Returns:

• OperationsSearchBuilder(./searching/builder/OperationsSearchBuilder)

operationTypeBuilder

function operationTypeBuilder(organization: *,name: *,operationTypeObj: *) -> 'OperationType'

This return a util to update an Operation Type

Arguments:

• organization *
• name *
• operationTypeObj *

Returns:

• OperationType(./operationTypes/OperationType)

operationTypesSearchBuilder

function operationTypesSearchBuilder() -> 'OperationTypesSearchBuilder'

This return a OperationTypesSearchBuilder to build a specific OperationTypesSearch

Returns:

• OperationTypesSearchBuilder

organizationManufacturerModelsBuilder

function organizationManufacturerModelsBuilder(organization: *,manufacturerIdentifier: *) -> 'OrganizationManufacturerModelsBuilder'

This return a OrganizationManufacturerModelsBuilder to build a specific OrganizationManufacturerModelsBuilder

Arguments:

• organization *
• manufacturerIdentifier *

Returns:

• OrganizationManufacturerModelsBuilder

organizationManufacturersBuilder

function organizationManufacturersBuilder(organization: *) -> 'OrganizationManufacturersBuilder'

This return a OrganizationManufacturersBuilder to build a specific OrganizationManufacturersBuilder

Arguments:

• organization *

Returns:

• OrganizationManufacturersBuilder

organizationsBuilder

function organizationsBuilder() -> 'Organizations'

This return a OrganizationsBuilder to build a specific OrganizationsBuilder

Returns:

• Organizations(./organizations/Organizations)

plansSearchBuilder

function plansSearchBuilder() -> 'PlansSearchBuilder'

This return a PlansSearchBuilder to build a specific PlansSearchBuilder

Returns:

• PlansSearchBuilder(./searching/builder/PlansSearchBuilder)

powerSupplyMessageBuilder

function powerSupplyMessageBuilder() -> 'PowerSupply'

Returns:

• PowerSupply(./collection/devices/collect/PowerSupply)

provisionProcessorsBuilder

function provisionProcessorsBuilder() -> 'provisionProcessorsBuilder'

This return a ProvisionsProcesorsBuilder to build a specific ProvisionsProcesorsBuilder

Returns:

• provisionProcessorsBuilder

qratingsBuilder

function qratingsBuilder() -> 'QratingsBuilder'

This return a Qrating to build a specific Qrating

Returns:

• QratingsBuilder

rawSearchBuilder

function rawSearchBuilder() -> 'RawSearchBuilder'

Create custom search with custom url and raw filter

Returns:

• RawSearchBuilder(./searching/builder/RawSearchBuilder)

resourceTypeSearchBuilder

function resourceTypeSearchBuilder() -> 'ResourceTypeSearchBuilder'

This return a ResourceTypeSearchBuilder to build a specific ResourceTypeSearchBuilder

Returns:

• ResourceTypeSearchBuilder(./searching/builder/ResourceTypeSearchBuilder)

ruleConfigurationBuilder

function ruleConfigurationBuilder(organization: *,channel: *,name: *,ruleConfigObj: *) -> 'RuleConfigurations'

This return a util to update a Rule Configuration

Arguments:

• organization *
• channel *
• name *
• ruleConfigObj *

Returns:

• RuleConfigurations(./rulesConfiguration/RuleConfigurations)

rulesSearchBuilder

function rulesSearchBuilder() -> 'RulesSearchBuilder'

This return a RulesSearchBuilder to build a specific RulesSearch

Returns:

• RulesSearchBuilder(./searching/builder/RulesSearchBuilder)

Sapi

function Sapi()

scheduleImageExecutionBuilder

function scheduleImageExecutionBuilder() -> 'ImageExecution'

This return a util to build schedule image executions

Returns:

• ImageExecution(./schedule/ImageExecution)

schedulePipelineBuilder

function schedulePipelineBuilder() -> 'SchedulePipeline'

This return a util to build a pipeline

Returns:

• SchedulePipeline

scheduleRestRequestBuilder

function scheduleRestRequestBuilder() -> 'RestRequest'

This return a util to build schedule rest requests

Returns:

• RestRequest(./schedule/RestRequest)

SE

function SE()

serviceGroupSearchBuilder

function serviceGroupSearchBuilder() -> 'ServiceGroupSearchBuilder'

This return a ServiceGroupSearchBuilder to build a specific ServiceGroupSearchBuilder

Returns:

• ServiceGroupSearchBuilder(./searching/builder/ServiceGroupSearchBuilder)

softwareMessageBuilder

function softwareMessageBuilder() -> 'Software'

Returns:

• Software(./collection/devices/collect/Software)

softwaresBuilder

function softwaresBuilder(organization: *) -> 'SoftwaresBuilder'

This return a SoftwaresBuilder to build a specific SoftwaresBuilder

Arguments:

• organization *

Returns:

• SoftwaresBuilder

softwaresSearchBuilder

function softwaresSearchBuilder() -> 'SoftwaresSearchBuilder'

This return a SoftwaresSearchBuilder to build a specific SoftwaresSearchBuilder

Returns:

• SoftwaresSearchBuilder(./searching/builder/SoftwaresSearchBuilder)

storageMessageBuilder

function storageMessageBuilder() -> 'Storage'

Returns:

• Storage(./collection/devices/collect/Storage)

subscriberMessageBuilder

function subscriberMessageBuilder() -> 'SubscriberMessage'

Returns:

• SubscriberMessage

subscribersSearchBuilder

function subscribersSearchBuilder() -> 'SubscribersSearchBuilder'

This return a SubscribersSearchBuilder to build a specific DeviceSearch

Returns:

• SubscribersSearchBuilder(./searching/builder/SubscribersSearchBuilder)

subscriptionMessageBuilder

function subscriptionMessageBuilder() -> 'SubscriptionMessage'

Returns:

• SubscriptionMessage

subscriptionsSearchBuilder

function subscriptionsSearchBuilder() -> 'SubscriptionsSearchBuilder'

This return a SubscriptionsSearchBuilder to build a specific DeviceSearch

Returns:

• SubscriptionsSearchBuilder(./searching/builder/SubscriptionsSearchBuilder)

tasksSearchBuilder

function tasksSearchBuilder() -> 'TasksSearchBuilder'

This return a TasksSearchBuilder to build a specific TasksSearch

Returns:

• TasksSearchBuilder(./searching/builder/TasksSearchBuilder)

ticketPrioritySearchBuilder

function ticketPrioritySearchBuilder() -> 'TicketPrioritySearchBuilder'

This return a TicketPrioritySearchBuilder to build a specific TicketPrioritySearchBuilder

Returns:

• TicketPrioritySearchBuilder(./searching/builder/TicketPrioritySearchBuilder)

ticketSeveritySearchBuilder

function ticketSeveritySearchBuilder() -> 'TicketSeveritySearchBuilder'

This return a TicketSeveritySearchBuilder to build a specific TicketSeveritySearchBuilder

Returns:

• TicketSeveritySearchBuilder(./searching/builder/TicketSeveritySearchBuilder)

ticketsSearchBuilder

function ticketsSearchBuilder() -> '*'

This return a TicketsSearchBuilder to build a specific TicketSearch

Returns:

• *

ticketStatusSearchBuilder

function ticketStatusSearchBuilder() -> 'TicketStatusSearchBuilder'

This return a TicketStatusSearchBuilder to build a specific TicketStatusSearchBuilder

Returns:

• TicketStatusSearchBuilder(./searching/builder/TicketStatusSearchBuilder)

timeserieDatasetBuilder

function timeserieDatasetBuilder(organization: *,timeserie: *) -> 'TimeserieDatasetBuilder'

This return a TimeserieDatasetBuilder to build a specific TimeserieDataset

Arguments:

• organization *
• timeserie *

Returns:

• TimeserieDatasetBuilder(./searching/builder/TimeserieDatasetBuilder)

timeserieDownsamplerBuilder

function timeserieDownsamplerBuilder(organization: *,timeserie: *,entityId: *) -> 'TimeserieDownsamplerBuilder'

This return a TimeserieDownsamplerBuilder to build a specific TimeserieDownsampler

Arguments:

• organization *
• timeserie *
• entityId *

Returns:

• TimeserieDownsamplerBuilder(./searching/builder/TimeserieDownsamplerBuilder)

timeseriesBuilder

function timeseriesBuilder() -> 'Timeseries'

This return a TimeserieBuilder to build a specific timeserie

Returns:

• Timeseries(./timeseries/Timeseries)

timeserieSearchBuilder

function timeserieSearchBuilder(organization: *,timeserie: *) -> 'TimeserieSearchBuilder'

This return a TimeserieSearchBuilder to build a specific TimeserieSearch

Arguments:

• organization *
• timeserie *

Returns:

• TimeserieSearchBuilder(./searching/builder/TimeserieSearchBuilder)

timeseriesFunctionBuilder

function timeseriesFunctionBuilder(organization: *,identifier: *) -> 'TimeseriesFunction'

This return a TimeserieBuilder to build a specific timeserie

Arguments:

• organization *
• identifier *

Returns:

• TimeseriesFunction(./timeseriesFunctionsCatalog/TimeseriesFunction)

timezoneSearchBuilder

function timezoneSearchBuilder() -> 'TimezoneSearchBuilder'

This return a TimezoneSearchBuilder to build a specific TimezoneSearchBuilder

Returns:

• TimezoneSearchBuilder(./searching/builder/TimezoneSearchBuilder)

usageMessageBuilder

function usageMessageBuilder() -> 'Usage'

Returns:

• Usage(./collection/devices/collect/Usage)

userLanguagesSearchBuilder

function userLanguagesSearchBuilder() -> 'UserLanguagesSearchBuilder'

This return a UserLanguagesSearchBuilder to build a specific UserLanguagesSearchBuilder

Returns:

• UserLanguagesSearchBuilder(./searching/builder/UserLanguagesSearchBuilder)

userProfilesSearchBuilder

function userProfilesSearchBuilder() -> 'UserProfilesSearchBuilder'

This return a UserProfilesSearchBuilder to build a specific UserProfilesSearchBuilder

Returns:

• UserProfilesSearchBuilder(./searching/builder/UserProfilesSearchBuilder)

usersBuilder

function usersBuilder() -> 'User'

This return a util to create a user

Returns:

• User(./users/Users)

usersSearchBuilder

function usersSearchBuilder() -> 'UsersSearchBuilder'

This return a UsersSearchBuilder to build a specific UsersSearch

Returns:

• UsersSearchBuilder(./searching/builder/UsersSearchBuilder)

workgroupRelationsBuilder

function workgroupRelationsBuilder() -> 'WorkgroupRelations'

This return a WorkgroupRelationsBuilder to build a specific workgroup relation

Returns:

• WorkgroupRelations(./workgroups/WorkgroupRelations)

workgroupsBuilder

function workgroupsBuilder() -> 'Workgroups'

This return a WorkgroupsBuilder to build a specific workgroup

Returns:

• Workgroups(./workgroups/Workgroups)

workgroupsSearchBuilder

function workgroupsSearchBuilder() -> 'WorkgroupsSearchBuilder'

This return a WorkgroupsSearchBuilder to build a specific WorkgroupsSearch

Returns:

• WorkgroupsSearchBuilder(./searching/builder/WorkgroupsSearchBuilder)