Get Rule | JavaScript API Client V3 (Deprecated)

index.getRule(string objectID, callback)

About this method

Get the object/definition of a specific Rule.

Examples

1
$rule = $index->getRule('a-rule-id');

1
2
# Retrieve a Rule by its unique ID.
index.get_rule('a-rule-id')

1
2
3
4
5
6
// Retrieve a Rule by its unique ID.
index.getRule('a-rule-id', (err, content) => {
  if (err) throw err;

  console.log(content);
});

1
2
# Retrieve a Rule by its unique ID.
index.get_rule('a-rule-id')

1
2
3
4
Rule rule = index.GetRule("a-rule-id");

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

1
2
3
4
Rule rule = index.getRule("a-rule-id");

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

1
rule, err := i.GetRule("a-rule-id")

1
2
3
val synonymRule: Future[Rule] = client.execute {
  get rule "a-rule-id" from "index_name"
}

1
index.getRule(ObjectID("myID"))

Parameters

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

1
2
3
4
5
6
7
8
9
10
11
12
{
  "objectID": "a-rule-id",
  "condition": {
    "pattern": "smartphone",
    "anchoring": "contains"
  },
  "consequence": {
    "params": {
      "filters": "category = 1"
    }
  }
}