Api clients
/
JavaScript
/
V3
/
Methods
Jan. 22, 2021
Get Rule | JavaScript API Client V3 (Deprecated)
This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.
Required API Key: any key with the
settings ACL
Method signature
index.getRule(string objectID, callback)
About this method
Get the object/definition of a specific Rule.
Examples
Copy
Copy
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
Copy
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"
}
}
}
objectID
|
string
objectID of the Rule. |
condition
|
list
Condition of the rule. |
consequence
|
list
Consequence of the rule. |
