Sign in

v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB
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 (e.g. power_on, power_off, upgrade). Server-side validated against Flow's allow-list for the 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.