Skip to main content

Создание модели данных

Модель данных представляет собой описание объекта предметной области, которого можно представить в виде структуры в формате JSON. Все узлы структуры должны быть названы латинскими буквами, слова без пробелом в нижнем регистре. 

Для создания новой модели данных перейдите в раздел разработчика в проекте Сервисы ТПУ

Вы видите только модели данных, которые вы создали (авторы) или с вами поделились другие разработчики.

В правом верхнем углу нажмите кнопку "Добавить" и заполните все основные поля.

Параметр Значение
Название Краткое название модели данных
Алиас Уникальный алиас модели, будет использовать в API и в синхронизации
Описание Полное описание модели данных
Вид доступа к модели данных

Уровень доступа

  1. Всем
  2. Только пользователям (требуется авторизация)
  3. Только корпоративным пользователям (действующий студент или сотрудник)
Время жизни кеша в секундах

Время жизни кэша сформированного объекта модели данных в памяти, для ускорения работы.

 

Если кэширование не требуется - значение в этом поле нужно указать 0. 

Приложения модели

Перечень приложений, которые могут обращаться к указанной модели данных.

 

Каждое приложение должно передавать свой публичный ключ доступа.

Источник для корневого узла

По умолчанию для структуры модели данных создается древовидное представление с корневым элементом (root). Данное значение в дальнейшем можно будет поменять.

 

У одного объекта модели данных может быть только один корневой элемент.

В качестве источников данных для узлов структуры могут быть использованы только 3 типа динамических источников данных.

  1. Кортеж
  2. Массив
  3. Список

Редактирование описания структуры модели данных осуществляется через контекстное меню в режиме редактирования. Для добавления / редактирование / удаления узлов - требуется воспользоваться соответствующими элементами меню.

image.png

При редактировании узла требуется указать алиас (должен быть обязательно совместим со стандартом JSON) и источник данных (должен быть подготовлен заранее)

image.png

Для связи дочерних элементов с родительскими требуется указать хотя бы один внешний ключ, пересечение может быть организовано по составному ключу. 

image.png

Для оперативной корректировки источника данных в контекстном меню есть ссылка на переход в режим редактирование. Источник данных можно редактировать, если вы его автор или с вами поделились доступом.