NEnetxms
Objects

Update power domain configuration

Changed on

Update the power domain's settings: domain type, feed tag and rated power. Merge-patch semantics: any subset of fields can be sent; omitted fields are left unchanged.

This property group applies to Power domain objects only; sending it to any other object class returns 400.

patch/v1/objects/{object-id}/power-domain

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/objects/{object-id}/power-domain
  • Auth
    HTTP bearer

Path parameters

object-idinteger required

Request body

domainType'GRID_ENTRY' | 'GENERATOR' | 'UPS' | 'PDU' | 'BUSWAY' | 'OTHER'

Role of the power domain in the electrical distribution tree.

feedTagstring nullable

Free feed label, conventionally A or B. May be empty for grid entry domains.

ratedPowerinteger

Nameplate power in watts; 0 means undeclared.

Response

Power domain configuration updated; full updated object returned.

aliasstring

Object alias

categoryinteger

Object category ID

class'AccessPoint' | 'AgentPolicyLogParser' | 'Asset' | 'AssetGroup' | 'AssetRoot' | 'BusinessService' | 'BusinessServiceProto' | 'BusinessServiceRoot' | 'Chassis' | 'Cluster' | 'Condition' | 'Container' | 'CoolingZone' | 'Dashboard' | 'DashboardGroup' | 'DashboardRoot' | 'Facility' | 'Generic' | 'Interface' | 'MobileDevice' | 'Network' | 'NetworkMap' | 'NetworkMapGroup' | 'NetworkMapRoot' | 'NetworkService' | 'Node' | 'NodeLink' | 'PowerDomain' | 'Rack' | 'Report' | 'ReportGroup' | 'ReportRoot' | 'Room' | 'Sensor' | 'ServiceCheck' | 'ServiceRoot' | 'Subnet' | 'Template' | 'TemplateGroup' | 'TemplateRoot' | 'VPNConnector' | 'Zone'
guidstring uuid

Object GUID

idinteger

Object ID

namestring

Object name

timestampstring date-time

Object last change timestamp

timeZonestring nullable

Effective IANA time zone name (own or inherited from a parent object), null if not set.

timeZoneRulestring nullable

POSIX TZ rule of the effective time zone, null if not set.

timeZoneSourceinteger

ID of the parent object the time zone is inherited from, or 0 when the time zone is defined on this object or not set.

status0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

Changes

  • 53fbfac7f424Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 2827204d68d9Revision changes
    • warning

      added the new Room enum value to the response property for the response status