Entity Builder

EntityBuilder

EntityBuilder Objects

class EntityBuilder()

This is a base object that contains all you can do about Devices.

constructor
function constructor()

Constructor

Arguments:

  • Reference InternalOpenGateAPI - to the API object.
assetsBuilder
function assetsBuilder(organization: string,timeout: number) -> 'Promise'

Get a AssetBuilder for operate with entities of type asset

Arguments:

  • organization string - required field
  • timeout number (optional) - timeout on request

Returns:

  • Promise

Example:

ogapi.assetsBuilder('orgname').then(function(assetBuilder){//...}).catch()
devicesBuilder
function devicesBuilder(organization: string,timeout: number) -> 'Promise'

Get a DeviceBuilder for operate with entities of type device

Arguments:

  • organization string - required field
  • timeout number (optional) - timeout on request

Returns:

  • Promise

Example:

ogapi.devicesBuilder('orgname').then(function(deviceBuilder){//...}).catch()
newCsvBulkBuilder
function newCsvBulkBuilder(organization: string,resource: string,timeout: number,async: boolean) -> 'CsvBulkBuilder'

Get a new CsvBulkBuilder

Arguments:

  • organization string - required field.
  • resource string - required field. Type of resource: entities or tickets
  • timeout number (optional) - timeout in millisecons. The request will have a specific time out if it will be exceeded then the promise throw an exception
  • async boolean (optional) - forces async execution for the bulk operation

Returns:

  • CsvBulkBuilder

Example:

 ogapi.newCsvBulkBuilder('orgname', 'entities', 10000, false)
 ogapi.newCsvBulkBuilder('orgname', 'entities', 10000, true)
newJsonBulkBuilder
function newJsonBulkBuilder(organization: string,resource: string,timeout: number,async: boolean) -> 'JsonBulkBuilder'

Get a new JsonBulkBuilder

Arguments:

  • organization string - required field.
  • resource string - required field. Type of resource: entities or tickets
  • timeout number (optional) - timeout in millisecons. The request will have a specific time out if it will be exceeded then the promise throw an exception
  • async boolean (optional) - forces async execution for the bulk operation

Returns:

  • JsonBulkBuilder

Example:

 ogapi.newJsonBulkBuilder('orgname', 'entities', 10000)
newJsonFlattenedBulkBuilder
function newJsonFlattenedBulkBuilder(organization: string,resource: string,timeout: number,async: boolean) -> 'JsonFlattenedBulkBuilder'

Get a new JsonFlattenedBulkBuilder

Arguments:

  • organization string - required field.
  • resource string - required field. Type of resource: entities or tickets
  • timeout number (optional) - timeout in millisecons. The request will have a specific time out if it will be exceeded then the promise throw an exception
  • async boolean (optional) - forces async execution for the bulk operation

Returns:

  • JsonFlattenedBulkBuilder

Example:

 ogapi.newJsonFlattenedBulkBuilder('orgname', 'entities', 10000)
subscribersBuilder
function subscribersBuilder(organization: string,timeout: number) -> 'Promise'

Get a SubscriberBuilder for operate with entities of type subscriber

Arguments:

  • organization string - required field
  • timeout number (optional) - timeout on request

Returns:

  • Promise

Example:

ogapi.subscribersBuilder('orgname').then(function(subscriberBuilder){//...}).catch()
subscriptionsBuilder
function subscriptionsBuilder(organization: string,timeout: number) -> 'Promise'

Get a SubscriptionBuilder for operate with entities of type subscription

Arguments:

  • organization string - required field
  • timeout number (optional) - timeout on request

Returns:

  • Promise

Example:

ogapi.subscriptionsBuilder('orgname').then(function(subscriptionBuilder){//...}).catch()
ticketsBuilder
function ticketsBuilder(organization: string,timeout: number) -> 'Promise'

Get a TicketBuilder for operate with entities of type ticket

Arguments:

  • organization string - required field
  • timeout number (optional) - timeout on request

Returns:

  • Promise

Example:

ogapi.ticketsBuilder('orgname').then(function(ticketBuilder){//...}).catch()