Word
Update/Add/Remove dictionary words
Defined in: word.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Word(dictionaryname, dictionaryid, word, uuid, thesaurus, synonyms, action)
Endpoint for managing words within dictionaries.
|
Class Detail
Word(dictionaryname, dictionaryid, word, uuid, thesaurus, synonyms, action)
Endpoint for managing words within dictionaries. New terms can be created as well as updating existing
- Parameters:
- dictionaryname Optional
- the name of the dictionary to update/create the word from. This or dictionaryid are required
- dictionaryid Optional
- the id of the dictionary to update/create the word from. This or dictionaryname are required
- word Optional
- The word to create or find to update
- uuid Optional
- The uuid to look for the word with. If not found, will be applied as the uuid for the new word
- thesaurus Optional
- thesaurus content to apply
- synonyms Optional
- synonym content to apply
- action Optional
- to remove a word, include this parameter with the value "delete"
- Returns:
- ["UUID of added word"]
/wf/restapi/v2/word (delete UK from dictionary with ID 4) Parameters: data={"word":"UK","dictionaryid":4,"action":"delete"} Response: []
/wf/restapi/v2/word (delete UK from region dictionary) Parameters: data={"word":"UK","dictionaryname":"region","action":"delete"} Response: []
/wf/restapi/v2/word (delete word with UUID of 56B58674-10CD-43DD-A76A-4F54B495F332 from dictionary) Parameters: data={"uuid":"56B58674-10CD-43DD-A76A-4F54B495F332","action":"delete"} Response: []
/wf/restapi/v2/word (update synonyms and thesaurus columns for a word with UUID of 56B58674-10CD-43DD-A76A-4F54B495F332) Parameters: data={"uuid":"8D083C34-743C-469D-8C3F-E94F76D00705","synonyms":"United Kingdom, England","thesaurus":"Paradise"} Response: []
/wf/restapi/v2/word (update a word based on the UUID assigned. If the UUID does not match an existing, the word will be created) Parameters: data={"uuid":"8D083C34-743C-469D-8C3F-E94F76D00705","word":"tacos"} Response: []
/wf/restapi/v2/word (Create a new word in the dictionary passed (can also use dictionaryid parameter). If the word is successfully created, the UUID will be returned. Parameters: data={"word":"tacos2","dictionaryname":"region"} Response: [{"word":"tacos2","uuid":"EF49FF93-ECB5-4533-AC7E-A9C5438FBC82"}]
/wf/restapi/v2/word (Create new words in the dictionary passed (can also use dictionaryid parameter). If the words are successfully created, UUIDs for each will be returned. Parameters: data=[{"word":"North%20America","dictionaryname":"region"},{"word":"APAC","dictionaryname":"region"},{"word":"EURO","dictionaryname":"region"}] Response: [{"word": "North America","uuid": "598D65DE-CEBC-438C-B1C4-936A88FFA7B3"}, {"word": "APAC","uuid": "34A101F0-0A36-4E31-93ED-ECF196F27241"}, {"word": "EURO","uuid": "D247992F-7720-4E7A-9891-8A9D89AA9230"}]