Nodes

POST

NODE manages Node information for the NODEs. Returns an XML string that contains Node information for the NODE installed on this Enth Appliance.

NOTE: Enth Internal, KEY must contains Enth Administrator privileges.


Methods

   POST    PUT


Consumes

   application/x-www-form-urlencoded


Produces

   text/html


Returns

    An XML string containing information about the configuration of the NODE.


Parameters

Parameter Data Type Required Administrator Description
KEY String Required A valid Enth Key (refer to Login). Must be an Owner or Administrator.
ACTIVE Boolean If ACTIVE is true, the NODE property ACTIVE is set to true. If ACTIVE is false, the NODE property ACTIVE is set to false. NOTE: Applies only to locally installed NODEs.
PENDING Boolean If PENDING is true, the NODE property PENDING is set to true. If PENDING is false, the NODE property PENDING is set to false. NOTE: Applies only to locally installed NODEs. Typically used by Enth when an anomaly is dectected.
LOGGING Integer LOGGING sets the LOGGING prefernce for the NODE. Valid values are 0 - limited logging, 1 - medium logging, 2 - intense logging
RESTART Boolean If RESTART is 1 (true), the NODE is restarted. NOTE: RESTART is a independant process, so calls to NODE will return prior to completion of the RESTART process,
LONGITUDE Double Administrator A valid Longitude, typically generated from the requesting device.
LATITUDE Double Administrator A valid Latitude, typically generated from the requesting device.
SOURCE String Administrator The name or type of requesting source or device.

Also See:    Login    Model    Models    Nodes

Code Example

   https://YourEnthAppliance/EnthAPI/users/node

Nodes

PUT

NODE manages Schema information about NODES.

If LOAD equals ENTH_STATIC, PUT adds a MODEL to the collection MODELS at this Enth Appliance. If the Enth Repository is available, the MODEL will also be added to the Enth Repository.

If LOAD equals ENTH_DYNAMIC, PUT adds the MODELS to the ENth Repository.

Returns an XML string that contains Schema information for the NODE.

NOTE: Enth Internal, KEY must contains Enth Administrator privileges.


Methods

   POST    PUT


Consumes

   application/x-www-form-urlencoded


Produces

   text/html


Returns

    An XML string containing the information about the configuration of the NODES.


Parameters

Parameter Data Type Required Administrator Description
KEY String Required A valid Enth Key (refer to Login). Must be an Owner or Administrator.
GUID String Required (or NAME) The GUID of the MODEL to be Administered.
NAME String Required (or GUID) The NAME of the MODEL to be Administered (NOTE: GUID is preferred).
MODEL String Required Administrator The JSON string for the MODEL to be added.
LOAD Integer Required Administrator LOAD determines the type of LOAD performed. LOAD has two valid values 1 (ENTH_STATIC) and 2 (ENTH_DYNAMIC). If LOAD equals ENTH_STATIC, PUT adds a MODEL to the collection MODELS at this Enth Appliance. If the Enth Repository is available, the MODEL will also be added to the Enth Repository. If LOAD equals ENTH_DYNAMIC, PUT adds the MODELS to the ENth Repository.
LONGITUDE Double Administrator A valid Longitude, typically generated from the requesting device.
LATITUDE Double Administrator A valid Latitude, typically generated from the requesting device.
SOURCE String Administrator The name or type of requesting source or device.

Also See:    Login    Models    Models    Nodes

Code Example

   https://YourEnthAppliance/EnthAPI/users/nodes