In order to create a dictionary using API you will need to get or create an API KEY from the company settings.
Note! - if case you created a new KEY in the company settings make sure to click Save at the bottom of the page.
With you client library use the API KEY to authenticate to Vitre API and create a POST request with the following request body (JSON only):
{
"name": "string",
"values": [
{
"childDictionaryId": 0,
"value": "string",
"position": 0,
"translations": "string",
"externalId": "string"
}
]
}
- name: Dictionary Name
- childDictionaryId: The Child Dictionary Id in the system. (optional)
Make sure to create the child dictionary before.
- value: Value description.
- position: The order in which the value will be. (optional)
If omitted the value will be as povided in the array - translation: Value translation in the following format
"translations": "{\"en-US\":\"\",\"he-IL\":\"\",\"ru-RU\":\"\"}" - externalId:the external identifier of the value in your inner systems