Api clients
/
Ruby
/
V1
/
Methods
Jun 25, 2024
Get Rule | Ruby API Client V1 (Deprecated)
Deprecated content
This documentation is for a deprecated version of Ruby API client .
Some features and settings may be missing or their usage may have changed.
Refer to the documentation for the
latest version of Ruby API client for up-to-date information.
Required API Key: any key with the
settings
ACL
Method signature
index.get_rule(String objectID)
About this method
Get the object/definition of a specific Rule.
Examples
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. |
Did you find this page helpful?