Dictionaries
/services/localizationservice/api/backup/dictionary/download
Выгрузить словарь с указанием типа выгружаемого файла.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
имя словаря, тип файла
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| dictionaryCode | string | Код словаря | нет | |
| fileType | string | Тип выгружаемого файла | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
/services/localizationservice/api/backup/dictionary/all/download
Скачать все словари
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
параметры для скачивания
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| format | string | Формат результирующего файла | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
/services/localizationservice/api/backup/dictionary/upload/csv
Загрузить словарь в формате csv
Имеется возможность удаления существующего словаря
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
файл словаря
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| data | string | Загружаемый словарь | нет | |
| fileType | string | Формат загружаемого файла | нет | |
| isDelete | boolean | Флаг удаления существующих переводов | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/localizationservice/api/backup/dictionary/upload/json
Загрузить словариь в формате json
Имеется возможность удаления существующего словаря
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
файл словаря
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| data | DictionaryInfoJson | |||
| fileType | string | Формат загружаемого файла | нет | |
| isDelete | boolean | Ключ удаления существующего словаря | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/localizationservice/api/backup/dictionary/upload/files/json
Загрузить словари в формате json
Имеется возможность удаления существующих словарей
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
файл словарей
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| dictionariesInfo | DictionaryInfoJsonRequest[] | Список словарей для загрузки | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/localizationservice/api/backup/dictionary/upload/files/csv
Загрузить словари в формате csv
Имеется возможность удаления существующих словарей
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
файл словарей
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| dictionariesInfo | string | Данные словаря | нет | |
| isDelete | boolean | Флаг удаления существующих переводов | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/localizationservice/api/dictionaries/all
Получить список всех словарей
Тип HTTP запроса: post
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | Info[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
/services/localizationservice/api/dictionaries/Get
Получить информацию о словаре по его коду
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Словарь
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| dictionaryCode | string | Код словаря | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | Info | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
/services/localizationservice/api/dictionaries/Add
Добавить новый словарь
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Информация о словаре
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| isReadOnly | boolean | Флаг "только для чтения" | нет | |
| code | string | Код | нет | |
| title | string | Описание | нет | |
| enabled | boolean | Доступность | нет | |
| isDefault | boolean | По умолчанию | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/localizationservice/api/dictionaries/Set
Изменить параметры словаря
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Информация о словаре
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| isReadOnly | boolean | Флаг "только для чтения" | нет | |
| code | string | Код | нет | |
| title | string | Описание | нет | |
| enabled | boolean | Доступность | нет | |
| isDefault | boolean | По умолчанию | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/localizationservice/api/dictionaries/delete
Удалить словарь и все его слова по его коду
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Словарь
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| dictionaryCode | string | Код словаря | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/localizationservice/api/dictionaries/Download
Выгрузить словарь с указанием типа выгружаемого файла.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
имя словаря, тип файла
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| dictionaryCode | string | Код словаря | нет | |
| fileType | string | Тип выгружаемого файла | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
/services/localizationservice/api/dictionaries/UploadCsv
Загрузить словарь в формате csv
Имеется возможность удаления существующего словаря
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
файл словаря
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| data | string | Загружаемый словарь | нет | |
| fileType | string | Формат загружаемого файла | нет | |
| isDelete | boolean | Флаг удаления существующих переводов | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/localizationservice/api/dictionaries/UploadJson
Загрузить словариь в формате json
Имеется возможность удаления существующего словаря
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
файл словаря
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| data | DictionaryInfoJson | |||
| fileType | string | Формат загружаемого файла | нет | |
| isDelete | boolean | Ключ удаления существующего словаря | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/localizationservice/api/dictionaries/UploadJsonFiles
Загрузить словари в формате json
Имеется возможность удаления существующих словарей
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
файл словарей
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| dictionariesInfo | DictionaryInfoJsonRequest[] | Список словарей для загрузки | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/localizationservice/api/dictionaries/UploadCsvFiles
Загрузить словари в формате csv
Имеется возможность удаления существующих словарей
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
файл словарей
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| dictionariesInfo | string | Данные словаря | нет | |
| isDelete | boolean | Флаг удаления существующих переводов | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/localizationservice/api/dictionaries/DownloadDictionaries
Скачать все словари
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
формат для скачивания
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
/services/localizationservice/api/dictionaries/downloadall
Скачать все словари
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
параметры для скачивания
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| format | string | Формат результирующего файла | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
/services/localizationservice/api/dictionaries/ChangeReadOnlyDictionaries
Изменить статус "только для чтения" словаря
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
имя словаря, статус
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| code | string | Код словаря | нет | |
| isReadOnly | boolean | Флаг только для чтения | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/localizationservice/api/dictionaries/Merge
Слияние словаря
возможные типы:
rewrite - переписать словарь полностью
update - обновить переводы в словаре и добавить несуществующие
delete - удалить переданные переводы (удаление производится по имени словаря, имени ключа и культуре)
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
данные словаря
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| type | string | Тип слияния | нет | |
| dictionaryInfo | DictionaryInfoJson |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |