NEnetxms
Objects

Update object status calculation/propagation parameters

Changed on

Update the algorithms and thresholds used to derive the object's compound status from its children, and to propagate that status upward. Merge-patch semantics: any subset of fields can be sent; omitted fields are unchanged. The four-element translation and thresholds arrays must be sent as complete four-element arrays.

patch/v1/objects/{object-id}/status-calculation

Request

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

Path parameters

object-idinteger required

Request body

calcAlginteger

Status calculation algorithm.

propAlginteger

Status propagation algorithm.

fixedStatusinteger

Fixed status value used with the "fixed" propagation algorithm.

shiftinteger

Status shift used with the "relative" propagation algorithm.

singleThresholdinteger

Single percentage threshold used with the "single threshold" calc algorithm.

translationinteger[]

Four-element status translation table (used with the "translated" propagation algorithm).

thresholdsinteger[]

Four-element percentage thresholds (used with the "multiple thresholds" calc algorithm).

Response

Status calculation 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