Skip to main content
GET
Get a Rule

Authorizations

Authorization
string
header
required

JWT from IDM (Authorization: Bearer )

Path Parameters

id
string<uuid>
required

Rule ID

Response

Rule retrieved successfully

Rule details

id
string<uuid>
required

Unique identifier for this Rule

Example:

"01900000-0000-7000-8000-000000000001"

rule
string
required

The rule text

Example:

"Avoid passive voice in all user-facing content."

active
boolean
required

Whether this rule is active

aiCheckEnabled
boolean
required

Whether this rule is used during AI-powered quality checks

allContentGroups
boolean
required

Whether this rule applies to all content groups

allLanguages
boolean
required

Whether this rule applies to all languages

contentGroups
object[] | null
required

Content Groups this rule applies to. Empty list means all content groups. Null means no content groups are assigned.

languages
object[] | null
required

Language details for languages this rule applies to. Empty list means all languages. Null means no languages are assigned.

createdAt
string<date-time>
required

When this rule was created

Example:

"2024-01-15T10:30:00Z"

lastModifiedAt
string<date-time>
required

When this rule was last modified

Example:

"2024-06-01T14:22:00Z"

styleGuide
null

Style Guide this rule was extracted from. Null when the rule is unlinked — either manually created or subsequently edited.

createdBy
null

User who created this rule

lastModifiedBy
null

User who last modified this rule