Get Rule
settings
ACL
$index->getRule(string objectID)
About this method
You are currently reading the JavaScript API client v4 documentation. Check our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.
You are currently reading the Ruby API client v2 documentation. Check our migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.
Get the object/definition of a specific Rule.
Examples
1
$rule = $index->getRule('a-rule-id');
Parameters
objectID
|
type: string
Required
The ID of the Rule to retrieve. |
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",
"conditions": [{
"pattern": "smartphone",
"anchoring": "contains"
}],
"consequence": {
"params": {
"filters": "category = 1"
}
}
}
objectID
|
string
objectID of the Rule. |
condition
|
list
Condition of the rule. |
consequence
|
list
Consequence of the rule. |