Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace RuleSummary

A list of rule resources. One or more rules can be defined for a data entity. Each rule can be defined on one or more attributes of the data entity.

Properties

Optional attributes

attributes: Array<RuleAttribute>

Attributes associated with a rule. A UNIQUEKEY rule would contain (at least) one attribute, for the local table column(s) on which uniqueness is defined.

Optional description

description: undefined | string

Detailed description of a rule.

Optional displayName

displayName: undefined | string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional externalKey

externalKey: undefined | string

External URI that can be used to reference the object. Format will differ based on the type of object.

key

key: string

Immutable unique key of a rule.

Optional lifecycleState

lifecycleState: model.LifecycleState

State of the rule.

Optional originType

originType: model.RuleOriginType

Origin type of the rule.

Optional referencedAttributes

referencedAttributes: Array<RuleAttribute>

Attributes associated with referenced rule, applicable only when rule type is FOREIGNKEY. A FOREIGNKEY rule would contain (at least) one attribute, for the local table column(s), and (at least) one referencedAttribute for referenced table column(s).

Optional referencedEntityKey

referencedEntityKey: undefined | string

Entity key that represents the referenced entity, applicable only when rule type is FOREIGNKEY.

Optional referencedEntityName

referencedEntityName: undefined | string

Entity name that represents the referenced entity, applicable only when rule type is FOREIGNKEY.

Optional referencedFolderKey

referencedFolderKey: undefined | string

Folder key that represents the referenced folder, applicable only when rule type FOREIGNKEY.

Optional referencedFolderName

referencedFolderName: undefined | string

Folder name that represents the referenced folder, applicable only when rule type FOREIGNKEY.

Optional referencedRuleKey

referencedRuleKey: undefined | string

Rule key that represents the referenced rule, applicable only when rule type is FOREIGNKEY.

Optional referencedRuleName

referencedRuleName: undefined | string

Rule name that represents the referenced rule, applicable only when rule type is FOREIGNKEY.

Optional ruleType

ruleType: model.RuleType

Type of a rule.

Optional timeCreated

timeCreated: Date

The date and time the rule was created, in the format defined by RFC3339. Example: {@code 2019-03-25T21:10:29.600Z}

Optional uri

uri: undefined | string

URI to the rule instance in the API.

Functions

getDeserializedJsonObj

getJsonObj