Datamodels Helper

DatamodelsHelper

DatamodelsHelper Objects

class DatamodelsHelper()

This is a base object for update and delete a IoT Datamodel

constructor

function constructor()

Constructor

Arguments:

• ogapi InternalOpenGateAPI - this is ogapi instance
• organization string - Organization where the IoT datamodel was create
• datamodel object - Json object of IoT datamodel to modify or delete.

addCategory

function addCategory(category: Object,datastreams: Array) -> 'DatamodelsHelper'

Add a category. If the field datastreams have value, they will add to this category

Arguments:

• category Object
• datastreams Array

Returns:

• DatamodelsHelper

addDatastream

function addDatastream(category: string,datastream: object) -> 'DatamodelsHelper'

Add a datastream to the indicated category

Arguments:

• category string
• datastream object

Returns:

• DatamodelsHelper

create

function create()

Create not supported on this builder. Use IoTDatamodelHelper instead.

removeCategory

function removeCategory(category: string) -> 'DatamodelsHelper'

Remove category

Arguments:

• category string

Returns:

• DatamodelsHelper

removeDatastream

function removeDatastream(category: string,id_datastream: string) -> 'DatamodelsHelper'

Remove datastream to the indicated category

Arguments:

• category string
• id_datastream string - of datastream

Returns:

• DatamodelsHelper

updateCategory

function updateCategory(old_category: string,new_category: string) -> 'DatamodelsHelper'

Update category name

Arguments:

• old_category string - name
• new_category string - name

Returns:

• DatamodelsHelper

updateDatastream

function updateDatastream(category: string,id_datastream: string,datastream: Object) -> 'DatamodelsHelper'

Update datastream to the indicated category

Arguments:

• category string
• id_datastream string - of datastream
• datastream Object - json object

Returns:

• DatamodelsHelper

withDescription

function withDescription(description: string) -> 'DatamodelsHelper'

Set the description attribute

Arguments:

• description string

Returns:

• DatamodelsHelper

withIdentifier

function withIdentifier(identifier: string) -> 'Datamodels'

Set the identifier attribute

Arguments:

• identifier string - required field

Returns:

• Datamodels

withName

function withName(name: string) -> 'DatamodelsHelper'

Set the name attribute

Arguments:

• name string - required field

Returns:

• DatamodelsHelper

withVersion

function withVersion(version: string) -> 'DatamodelsHelper'

Set the version attribute

Arguments:

• version string - required field

Returns:

• DatamodelsHelper