Dictionary
Shows the dictionaries and their words
Defined in: dictionary.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Dictionary(FILTERS, wordLimit)
Displays the dictionaries defined in MediaBeacon and the words in each dictionary.
|
Class Detail
Dictionary(FILTERS, wordLimit)
Displays the dictionaries defined in MediaBeacon and the words in each dictionary. Filtering can be applied to the "name" parameter to limit the dictionaries returned
- Parameters:
- FILTERS Optional
- Filtering can be applied to the "name" properties.
- wordLimit Optional, Default: 1000
- the number of words per dictionary to include in the response.
- Returns:
- [{"name":"theDictionaryName", "words":[anArray of dictionary words]}, ... ]
/wf/restapi/v2/dictionary
Parameters: none
Response:
[
{
"name": "Status:Approval",
"words": [
"Approved",
"Pending",
"Rejected"
]
},
{
"name": "Status:General",
"words": [
"Approved",
"Complete",
"In Progress",
"Not Allowed",
"Not Started",
"Pending",
"Pending Legal Approval",
"Pending License",
"Pending Regional Approval",
"Rejected",
"To Do"
]
}
, all Dictionaries...
]
/wf/restapi/v2/dictionary
Parameters:
name=Status:Approval
Response:
[
{
"name": "Status:Approval",
"words": [
"Approved",
"Pending",
"Rejected"
]
}
]
/wf/restapi/v2/dictionary
Parameters:
name=Status:Approval
wordLimit=2
Response:
[
{
"name": "Status:Approval",
"words": [
"Approved",
"Pending"
]
}
]
/wf/restapi/v2/dictionary
Parameters:
name=Status*
Response:
[
{
"name": "Status:Approval",
"words": [
"Approved",
"Pending",
"Rejected"
]
},
{
"name": "Status:General",
"words": [
"Approved",
"Complete",
"In Progress",
"Not Allowed",
"Not Started",
"Pending",
"Pending Legal Approval",
"Pending License",
"Pending Regional Approval",
"Rejected",
"To Do"
]
}
]