API Reference / API Methods / Rules / Batch 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

You are currently reading the documentation of the JavaScript API Client v4. Read our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

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.

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

A mapping of request options to send along with the request.

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.

Did you find this page helpful?