Get rule

Get a rule by its ID.

Required ACL: settings

To find the objectID for rules, use the searchRules method.

Examples

C#

Rule rule = index.GetRule("ruleID");

// Asynchronous
Rule rule = await index.GetRuleAsync("");

rule, err := i.GetRule("ruleID")

Rule rule = index.getRule("ruleID");

// Async version
CompletableFuture<Rule> rule = index.getRuleAsync("ruleID");

// Retrieve a Rule by its unique ID.
index.getRule('ruleID').then(rule => {
  console.log(rule);
});

index.getRule(ObjectID("ruleID"))

$rule = $index->getRule('ruleID');

# Retrieve a Rule by its unique ID.
index.get_rule('ruleID')

# Retrieve a Rule by its unique ID.
index.get_rule('ruleID')

val synonymRule: Future[Rule] = client.execute {
  get rule "ruleID" from "index_name"
}

index.getRule(withID: "ruleID") { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Parameters

objectID · string · required

The ID of the rule to retrieve.

Response

condition · list

Condition of the rule.

consequence · list

Consequence of the rule.

objectID · string

objectID of the Rule.

Response as JSON

This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use the getLogs method. Don’t rely on the order of properties—JSON objects don’t preserve key order.

JSON

{
  "objectID": "a-rule-id",
  "conditions": [{
    "pattern": "smartphone",
    "anchoring": "contains"
  }],
  "consequence": {
    "params": {
      "filters": "category = 1"
    }
  }
}