Sign in
Objects

Modify business service check

Partially update business service check; only fields present in the request are changed. The request is validated as a whole, so the check is left unchanged on error. Checks created automatically (from prototype or by auto-binding) cannot be modified. Changes to a prototype check are propagated to all business services created from the prototype. Requires modify access to the object.

patch/v1/objects/{object-id}/business-service-checks/{check-id}

Request body

type'object' | 'dci' | 'script'
descriptionstring
relatedObjectIdinteger
relatedDciIdinteger
statusThresholdinteger
scriptstring nullable

NXSL script source; compiled on save when check type is script, compilation errors are reported as 400

Response

Check modified.

idinteger
serviceIdinteger

ID of business service or prototype owning this check

type'object' | 'dci' | 'script' | 'none'
descriptionstring
relatedObjectIdinteger

Object whose status is checked (object and DCI checks); for script checks, object passed to the script as $object (0 if none)

relatedDciIdinteger

DCI whose threshold state is checked (DCI checks)

statusThresholdinteger

Object or DCI status at which check fails; 0 means use server default

scriptstring nullable

NXSL script source (script checks)

statusinteger

Current check status (0 = normal, 2 = minor, 4 = critical)

failureReasonstring

Reason of last failure

prototypeServiceIdinteger

ID of prototype this check was created from (equals serviceId for auto-bound checks), 0 for manually created checks

prototypeCheckIdinteger

ID of prototype check this check was created from, 0 if none

autoCreatedboolean

True if check was created automatically (from prototype or by auto-binding) and cannot be modified

Changes

Changed in 1 of the 128 revisions of this API.1