Design rules search

GET/v1/design/rule-search

Signed-in sessionLaunch key product.designOperation design_rules_search

An internal tool for the components agents build and the rules they follow.

Query parameters

expectedAuthorizationVersionstring
includeDeletedfalse | true
qstringRequired

Returns

rulesobject[]Required

Errors

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

GET/v1/design/rule-search

curl "$SPECIFY_API_ORIGIN/v1/design/rule-search?q=<q>" \
  -H "Authorization: Bearer $SPECIFY_SESSION_TOKEN" \
  -H "X-Specify-Account-Id: <accountId>" \
  -H "X-Specify-Service-Tenancy-Id: <serviceTenancyId>"

Response

{
  "result": {
    "rules": [
      {
        "text": "<text>",
        "kind": "accessibility",
        "scope": {
          "kind": "base"
        },
        "scopeLabel": "<scopeLabel>",
        "examples": [
          "<example>"
        ],
        "antiExamples": [
          "<antiExample>"
        ],
        "status": "deleted",
        "version": 1,
        "number": 1,
        "updatedAt": 1,
        "updatedBy": {
          "kind": "agent",
          "name": "<name>"
        }
      }
    ]
  }
}

Design rules search

Headers

Query parameters

Returns

Errors