Get Synonym | 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.

Required API Key: any key with the editSettings ACL

Method signature

index.getSynonym(string objectID, callback)

See code examples

About this method

Get a single synonym using its object id.

Examples

To retrieve a synonym by objectID:

Copy

Copy
$synonym = $index->getSynonym("a-unique-identifier");

Parameters


            objectID

type: string

Required

objectID of the synonym you want 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

        {
  "objectID": "a-unique-identifier",
  "type": "synonym",
  "synonyms": [
    "car",
    "vehicle"
  ]
}

      

`objectID`	string Required for only some languages Must contain the same value as the objectId above.
`type`	string Required There are 4 synonym types. The parameter can be one of the following values: `synonym` `oneWaySynonym` `altCorrection1` or `altCorrection2` `placeholder`
`synonyms`	list Required if type=synonym or type=oneWaySynonym A list of synonyms.
`input`	string Required if type=oneWaySynonym Defines the synonym. A word or expression, used as the basis for the array of synonyms.
`word`	string Required if type=altCorrection1 or type=altCorrection2 A single word, used as the basis for the below array of corrections.
`corrections`	list Required if type=altCorrection1 or type=altCorrection2 An list of corrections of the `word`.
`placeholder`	string Required if type=placeholder A single word, used as the basis for the below list of replacements.
`replacements`	list Required if type=placeholder An list of replacements of the `placeholder`.