API Консоль - Сервис структур

API Консоль - это веб-приложение позволяющее вызывать любые методы, любых сервисов платформы Hivext. Через него можно зарегистрироваться в системе, получить идентификаторы приложений, создать нужные типы данных и объекты - все что предусмотрено платформой можно сделать через API Консоль.

Для начала работы с сервисом Струткур необходимо получить идентификатор приложения (см. API Консоль - Генерация идентификаторов приложений).

После генерации идентификатора приложения можно приступить к созданию необходимых типов и объектов (также типы и объекты можно создавать вызывая методы сервиса из кода вашего приложения минуя API Консоль).

Запускаем API Консоль http://code.hivext.ru/development/APIConsole/

Шаг 1 : Создаем новый тип данных

Выбираем сервис Структуры, заполняем поля для метода DefineType и вызываем его:

Для примера создадим тип данных Post (сообщение пользователя) который будет содержать поля: Uid (int) - идентификатор пользователя, Name (string) - имя автора, Subject (string) - тема, Content (string) - сообщение.

type = Post
fileds = { Uid : "int", Name : "string", Subject : "string", Content : "string" }

Тип создан и в базе данных приложения появилась новая таблица с указанными полями.

Шаг 2 : Смотрим какие типы созданы для приложения

Вызываем метод GetTypes:

Если структур много, то можно указать диапазон выборки, параметры from и count.

Отобразился только что созданный тип данных Post, можно заметить что появилось поле id (int) - это зарезервированное поле создается автоматически и при последующем создании объектов этого типа содержит уникальный идентификатор объекта.

Шаг 3 : Создадим объект

Вызываем метод CreateObject:

Укажем что создаем объект типа Post и заранее передадим значения свойств.

type = Post
data = { Name : "Alexandrov Constantin M.", Subject : "Я люблю Hivext", Content : "Hivext классная платформа =)", Uid : 5 }

Объект создан успешно, в ответе пришло значение идентификатора объекта id : 1.

Шаг 4 : Получение множества объектов

Существует два метода получения множества объектов: GetObjects и GetObjectsByCriteria.
Если объектов много предусмотрены параметры from и count для постраничного вывода.

Вызываем метод GetObjects:

Укажем что нам требуются все объекты типа Post.

type = Post

Вызываем метод GetObjectsByCriteria:

Укажем что нам требуются объекты типа Post.
Также укажем критерий выборки чтобы в названии или содержании встречалось слово hivext.
Подробнее о критериях выборки http://doc.hivext.ru/index.php/Структуры.GetObjectsByCriteria.

type = Post
criteria = Subject ILIKE "%hivext%" OR Content ILIKE "%hivext%"