Class RuleAttributesRequest

Attributes for creating or updating a rule. Server-managed fields (created_at, modified_at, custom) are excluded.

Hierarchy

  • RuleAttributesRequest

Constructors

constructor

Properties

additionalProperties? description? enabled? level? name? owner? scopeQuery? scorecardName?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional description

description?: string

Explanation of the rule.

Optional enabled

enabled?: boolean

If enabled, the rule is calculated as part of the score.

Optional level

level?: number

The maturity level of the rule (1, 2, or 3).

Optional name

name?: string

Name of the rule.

Optional owner

owner?: string

Owner of the rule.

Optional scopeQuery

scopeQuery?: string

A query to filter which entities this rule applies to.

Optional scorecardName

scorecardName?: string

The scorecard name to which this rule must belong.

Settings

Member Visibility

Theme

Generated using TypeDoc