SpecifyDocs

Get design rule

/v1/design/rules/{id}

Signed-in sessionLaunch key product.designOperation design_rule_get

An internal tool for design rules and components that agents synthesize, review and promote, with evaluation runs to check them.

Path parameters

idstringRequired

Query parameters

expectedAuthorizationVersionstring

Returns

relationshipsobject[]Required
relationshipsTruncatedbooleanRequired
canProposebooleanRequired
evidenceLinksobject[]Required
parentLinknull | objectRequired
conflictsobject[]Required
clarificationLinksobject[]Required
clarificationsTruncatedbooleanRequired
parentRuleIdstring
baseReleaseDigeststring
transitionReceiptIdstring
status"active" | "archived" | "conflicting" | "proposed" | "superseded"Required
visibility"private" | "tenant"Required
versionnumberRequired
createdAtnumberRequired
updatedAtnumberRequired
textstringRequired
publicIdstringRequired
schemaVersion1Required
scopeobjectRequired
evidenceReviewIdsstring[]Required
citedGuidanceobject[]Required
ruleKeystringRequired
ruleVersionnumberRequired
class"accessibility" | "functional" | "principle" | "taste"Required
diffstringRequired
examplesstring[]Required
antiExamplesstring[]Required
conflictIdsstring[]Required
scopeKeystringRequired

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.