Batch Rules | 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.
editSettings
ACL
index.batchRules( array rules, { forwardToReplicas: boolean, clearExistingRules: boolean }, callback )
About this method
Create or update a specified set of Rules, or all Rules.
Each Rule is created or updated, depending on whether a Rule with the same objectID
already exists.
Examples
1
2
3
$rules = [$rule1, $rule2];
$index->saveRules($rules);
Parameters
rules
|
type: list of Rule objects
Required
See Rule. |
clearExistingRules
|
type: boolean
default: false
Optional
Whether the batch will remove all existing Rules before adding/updating the Rules. |
forwardToReplicas
|
type: boolean
default: false
Optional
Whether to forward the operation to the replica indices. |
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
{
"updatedAt":"2013-01-18T15:33:13.556Z",
"taskID": 678
}
updatedAt
|
string
Date at which the batch Rules job has been created. |
taskID
|
integer
The taskID used with the waitTask method. |