API Reference / API Methods / Rules / Batch Rules
Required API Key: any key with the editSettings ACL
Method signature
$index->saveRules(array rules)

$index->saveRules(array rules, [
  // All the following parameters are optional
  'forwardToReplicas' => boolean
  'clearExistingRules' => boolean
])

About this method # A

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 # A

1
2
3
$rules = [$rule1, $rule2];

$index->saveRules($rules);

Parameters # A

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.

requestOptions #
type: key/value mapping
default: No request options
Optional

A mapping of requestOptions to send along with the request.

Response # A

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

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.

Did you find this page helpful?
PHP v3