API и SDK / Типы данных

Типы данных

При работе через API QuickBPM  отправляет запрос к стороннему сервису и получает ответ, содержащий запрошенные данные.  API оперирует следующими типами данных:

Строка

Деньги

ФИО

Число

Номер телефона

Ссылка

Выбор да/нет

Электронная почта

Таблица

Дата/время

Изображение

Пользователи

Категория

Файлы

Приложение

Строка

JSON тип - строка

начало примера

Пример:

 

 {
    «key»: «example»
}

конец примера

Число

JSON тип - число

начало примера

Пример:

 

{
    «key»: 10
}

конец примера

Выбор да/нет

JSON тип - логическое значение

начало примера

Пример:

 

{
    «key»: true
}

конец примера

Дата/время

JSON тип - строка

Формат - RFC3339

начало примера

Пример:

 

{
   «key»: «2006-01-02T15:04:05Z07:00»
}

конец примера

Категория

JSON тип - массив объектов

Поля объектов:

code - код категории (строка)

name - название категории (строка)

начало примера

Пример:

 

{
    «key»: [ { «code»: «example», «name»: «Пример»} ]
}

конец примера

Деньги

JSON тип - объект

Поля объекта:

cents - значение в минимальной монете (копейка, цент, евроцент) (число)

currency - валюта (строка)

начало примера

Пример:

 

{
    «cents»: 1000,
    "currency»: «RUB»
}

конец примера

Номер телефона

JSON тип - массив объектов

Поля объектов:

type - тип телефона (строка)

tel - номер телефона - только значащие символы (строка)

начало примера

Пример:

 

{
    «key»: [ { «type»:«home», «tel»:«+790000000000» } ]
}

конец примера

Электронная почта

JSON тип - массив объектов

Поля объектов:

type - тип почты (строка)

email - адрес почты - только значащие символы (строка)

начало примера

Пример:

 

{
    «key»: [ { «type»:«home», «email»:«example@email.com» } ]
}

конец примера

Изображение

JSON тип - массив строк

значения - идентификаторы файлов изображений в системе

начало примера

Пример:

 

{
    «key»: [ «c44b66f6-216a-457e-a37e-ea8e373a4b77» ]
}

конец примера

Файлы

JSON тип - массив строк

значения - идентификаторы файлов в системе

начало примера

Пример:

 

{
    «key»: [ «c44b66f6-216a-457e-a37e-ea8e373a4b77» ]
}

конец примера

ФИО

JSON тип - объект

Поля объекта:

lastname - фамилия

firstname - имя

middlename - отчество

начало примера

Пример:

 

{
     «key»: {
          «lastname»: «Белозубов»,
          «firstname»: «Сергей»,
          «middlename»: «Львович»
   }
}

конец примера

Ссылка

JSON тип - строка

начало примера

Пример:

 

 {
    «key»: «http://site.org»
}

конец примера

Пользователи

JSON тип - массив строк

значения - идентификаторы пользователей

начало примера

Пример:

 

{
     «key»: [ «c44b66f6-216a-457e-a37e-ea8e373a4b77» ]
}

конец примера

Приложение

JSON тип - массив строк

значения - идентификаторы элементов приложения

начало примера

Пример:

 

{
    «key»: [ «c44b66f6-216a-457e-a37e-ea8e373a4b77» ]
}

конец примера

Таблица

JSON тип – объект

Поля объекта:

rows – массив строк. Каждая строка - объект, поля которого определяются при настройке таблицы. Ключи - это коды полей, значения зависит от типа. Если значение колонки задается по формуле, то оно вычисляется автоматически.  

result – объект результатов, поля которого определяются при настройке таблицы. В этот объект попадают только столбцы, для которых результат (значение в нижнем колонтитуле) вычисляется по формуле. Этот объект вычисляется  автоматически исходя из настроек колонок.

view – строчное представление таблицы, сформированное по шаблону. Это представление формируется автоматически.

начало примера

 

Пример:

{
   «key» : {
        «rows»: [
            {  «good_name» : «product 1», «count» : 10},
            {  «good_name» : «product 2», «count» : 20},
        ],
       «result»: { «count»: 30 },
       «view»: «Итого: 30 позиций»
    }  
}

конец примера