API Reference / API Methods / Dictionaries / Delete dictionary entries

Delete Dictionary Entries

Required API Key: any key with the editSettings ACL
Method signature
$client->deleteDictionaryEntries(
  string dictionary,
  array  objectIDs
);

About this method # A

Delete a batch of dictionary entries.

Examples # A

Delete stopword entries#

1
2
3
4
$client->deleteDictionaryEntries(
  'stopwords',
  array('down',' up', ...)
);

Parameters # A

dictionary #
type: string
Required

Type of the dictionary entries you want to delete. Can be either stopword, plural or compound

objectIDs #
type: array
Optional

An array of dictionary entries objectID.

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 indexing job has been created.

taskID #
integer

The taskID used with the waitTask method.

Did you find this page helpful?
PHP v3