GET /api/wake-rules/{ruleId}

Wake-up details and attached agents#

Listed permission codes are alternatives, not token scopes. The service also checks access to the requested records and rejects stale revisions or controller generations.

• Authentication, envelopes and pagination
• Language-neutral client examples

Path parameters#

object; fields below; unknown fields rejected

Validation#

check.object({ ruleId: check.identifier })

Referenced definitions:

• object
• identifier

Query parameters#

custom validation: none ; see function below

Query parameters are URL text. The validation function below specifies their format, defaults and combinations. Pagination applies only to operations that use it.

Additional checks#

The following checks apply in addition to the field limits.

Constraint on value:

export function none(input: unknown) {
    const parsed = listQuery([])(input);
    return parsed.ok ? success({}) : parsed;
}

Validation#

query.none

Referenced definitions:

• none

Request body#

empty object; unknown fields rejected

Validation#

check.empty

Referenced definitions:

• empty

Response data#

object; fields below; unknown fields rejected ( wakeRuleDetails )

Additional checks#

The following checks apply in addition to the field limits.

Constraint on message:

value => !!value.trim()

Constraint on schedule:

input => {
    if (!input || typeof input !== 'object' || !('kind' in input))
        return failure('invalid', 'Choose an interval or calendar schedule');
    if (input.kind === 'interval')
        return check.object({ kind: check.choice('interval'), seconds: check.integer(1, 31536000) })(input);
    if (input.kind === 'cron')
        return check.object({ kind: check.choice('cron'), expression: check.text(200), timeZone: check.text(100) })(input);
    return failure('invalid', 'Unknown schedule kind');
}

Validation#

wake.wakeRuleDetails

Referenced definitions:

• wakeRuleDetails

Response envelope#

A successful JSON response contains data and meta. Replace the data placeholder below with the response fields described above. Errors contain error instead of data.

{
  "data": "<value matching the response-data validator>",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000001"
  }
}