Sign in
Rule

Retrieve an Operation Rule

Get an Operation Rule by UUID.

Rules are site-scoped; siteId must be the Site that owns the rule. Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

get/v2/org/{org}/nico/task/rule/{id}

Query parameters

siteIdstring uuid required

ID of the Site that owns the rule (rules are site-scoped).

Response

OK

idstring uuid required

Unique identifier of the rule.

namestring required

Human-readable name of the rule. Required and non-empty.

descriptionstring

Optional free-form description.

operationType'PowerControl' | 'FirmwareControl' required

Type of operation this rule applies to. Immutable after creation.

operationCodestring required

Operation code within the operation type. For PowerControl, accepted values are power_on, force_power_on, power_off, force_power_off, restart, force_restart, warm_reset, and cold_reset. For FirmwareControl, accepted values are upgrade, downgrade, and rollback. The server validates the code against the selected type. Immutable after creation.

isDefaultboolean required

Whether this rule is currently the default for its (operationType, operationCode) tuple.

createdstring date-time required

Timestamp when the rule was created.

updatedstring date-time required

Timestamp when the rule was last updated.

Changes

Changed in 2 of the 90 revisions of this API.2