Метод работы с табличными ресурсами

Для получения данных табличных ресурсов выполните запрос с помощью API-метода rpc (перед выполнением запроса определите токен пользователя).

В запросе передаются параметры ресурса и указывается заголовок X-Delta, от которого зависит ответ:

Примечание. Если параметры ресурса не указаны, то будут использованы значения по умолчанию. Для скалярных параметров значения по умолчанию задаются после импорта ресурса. Для табличных параметров значением по умолчанию является пустая таблица с нулем строк.

curl -v '<IP-адрес или DNS-имя сервера>/api/v1/rpc/<название ресурса>/' -H 'Authorization: Bearer <токен пользователя>' --header 'Content-Type: application/json' -d '{"<имя входного параметра>": <значение входного параметра>}'

Trying 0.0.0.0...
TCP_NODELAY set
Connected to <IP-адрес или DNS-имя сервера> (0.0.0.0) port 80 (#0)
> POST /api/v1/rpc/<название ресурса>/ HTTP/1.1
> Host: <IP-адрес или DNS-имя сервера>
> User-Agent: curl/7.61.1
> Accept: /
> Authorization: Bearer <токен пользователя>
> Content-Type: application/json
> Content-Length: 12
>
upload completely sent off: 12 out of 12 bytes
< HTTP/1.1 200 OK
< Server: nginx/1.9.11
< Date: <дата>
< Content-Type: application/json; charset=utf-8
< Transfer-Encoding: chunked
< Connection: keep-alive
< Cache-Hash-Value: output_table-Hash%3A<хэш-сумма>
< ETag: "<идентификатор ETag>"
< Expires: <дата>
< Last-Modified: <дата>
< Content-Version: <номер версии>
< Vary: Accept, Cookie, Accept-Encoding
< Allow: GET, POST, HEAD, OPTIONS
< X-Frame-Options: SAMEORIGIN
<
[{"name": "<table_name>", "data": [[1, 3, "Данные"]]}]*

curl -v '<IP-адрес или DNS-имя сервера>/api/v1/rpc/<название ресурса>/' -H 'Authorization: Bearer <токен пользователя>' --header 'Content-Type: application/json' --header "X-Delta: v1-last" -d '{"<имя входного параметра>": "<значение входного параметра>"}'

< HTTP/ 1.1 200 OK
< Content-Version: "delta v1-v6"
< ...
< [{ "name" : "table_name1" , "insert_rows" : <строки таблицы>, "delete_ids" : [3 , 7 , 10 ]}]

В запросах заголовок Content-Type задает формат ответа:

При запросе полной таблицы кэшируемого ресурса с одной таблицей поддерживаются GET-параметры:

параметры для пагинации:

hh_order. Задает имя столбца для упорядочивания строк и порядок сортировки, например, «hh_order=name+asc»;
hh_skip. Задает число строк таблицы, которые необходимо пропустить при формировании ответа;
hh_limit. Задает число строк таблицы, которые необходимо вернуть в ответе;

параметры для фильтрации по значению. Параметры имеют название вида «col_<column_name>», например, «col_id=123»;
параметр table для фильтрации многотабличных ресурсов. Задает наименование таблицы, которая будет использоваться при запросе кэшируемого, многотабличного ресурса, например, «table=<наименование таблицы>».

Примечание. Для ресурсов с несколькими таблицами фильтрация и пагинация не поддерживаются.

Условия для параметров запроса:

фильтрация по значению выполняется до обработки параметров пагинации;
фильтр по значению можно применять только к столбцам типов «text» и «bigint» мобильной платформы;
условием фильтрации по значению является точное совпадение значения параметра из запроса со значением столбца соответствующего названия;
для столбцов типа «bigint» значения нужно использовать целые числовые значения;
одновременно может быть несколько фильтров по значению для разных столбцов;
повторное использование параметров с одинаковым названием в одном запросе не допустимо.

Пример

Доступен ресурс с одной таблицей ресурса «fruits», которая содержит столбцы:

Название столбца	Тип
_id	bigint
barcode	bigint
shelf_id	text
name	text
photo	bytea

Рассмотрим примеры запросов с фильтрацией и пагинацией данных в формате полной таблицы для ресурса с одной таблицей:

Запросы	Описание
curl -v "<IP-адрес или DNS-имя сервера>/api/v1/rpc/<fruits>/" -H "Authorization: Bearer <токен пользователя>"	Получить полный список фруктов.
curl -v "<IP-адрес или DNS-имя сервера>/api/v1/rpc/fruits/?hh_order=name+desc" -H "Authorization: Bearer <токен пользователя>"	Вернуть записи, отсортированные по имени по убыванию.
curl -v "<IP-адрес или DNS-имя сервера>/api/v1/rpc/fruits/?hh_order=name+asc&hh_skip=10&hh_limit=10" -H "Authorization: Bearer <токен пользователя>"	Отсортировать записи по имени по возрастанию, вернуть записи с 11 по 20.
curl -v "<IP-адрес или DNS-имя сервера>/api/v1/rpc/fruits/?col_shelf_id=North128" -H "Authorization: Bearer <токен пользователя>"	Получить фрукты, которые находятся на полке «North128».
curl -v "<IP-адрес или DNS-имя сервера>/api/v1/rpc/fruits/?col_shelf_id=North128&col_barcode=123456" -H "Authorization: Bearer <токен пользователя>"	Получить фрукты, которые находятся на полке «North128» и имеют штрихкод 123456.
curl -v "<IP-адрес или DNS-имя сервера>/api/v1/rpc/fruits/?hh_order=name+asc&hh_skip=10&hh_limit=10&col_shelf_id=North128&col_barcode=123456" -H "Authorization: Bearer <токен пользователя>"	Найти фрукты, которые находятся на полке «North128» и имеют штрихкод 123456. Потом отсортировать их по имени по возрастанию. Потом вернуть записи с 11 по 20.

В случае если работа ведется с ресурсом, отдающим одну таблицу, то фильтрация и пагинация для таких ресурсов доступна.

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

Если ответ формируется из кэша на сервере мобильной платформы, то он содержит уникальный идентификатор «ETag». Если кэш не используется, то «ETag'а» нет.

Для автоматического расчёта дельты с использованием идентификатора «ETag»:

Выполните запрос данных ресурса:

curl -v '<IP-адрес или DNS-имя сервера>/api/v1/rpc/<название ресурса>/' -H 'Authorization: Bearer <токен пользователя>' --header 'Content-Type: application/json' -d '{"<имя входного параметра>": "<значение входного параметра>"}'

Пример ответа:

* Trying 0.0 . 0.0 ...
* TCP_NODELAY set
* Connected to 0 ( 127.0 . 0.1 ) port 8000 (# 0 )
> GET /api/v1/rpc/resource_name/ HTTP/ 1.1
> Host: 0 : 8000
> User-Agent: curl/ 7.58 . 0
> Accept: */*
> Authorization: bearer <токен пользователя>
>
...
< ETag: "<идентификатор ETag>"
< Expires: Fri, 30 Mar 2018 13 : 31 : 29 GMT
< Last-Modified: Fri, 30 Mar 2018 12 : 31 : 29 GMT
< Content-Version: 1
...

После выполнения запроса производится обновление кэша на сервере мобильной платформы.

Выполните повторный запрос данных с указанием идентификатора «ETag»:

curl -v '<IP-адрес или DNS-имя сервера>/api/v1/rpc/<название ресурса>/' -H 'Authorization: Bearer <токен пользователя>' --header 'If-None-Match: "<идентификатор ETag>"' --header 'X-Delta: auto' --header 'Content-type: application/json' -d '{"<имя входного параметра>": "<значение входного параметра>"}'

Пример ответа с содержанием дельты между актуальной версией и версией полученного «ETag»:

* Trying 0.0 . 0.0 ...
* TCP_NODELAY set
* Connected to 0 ( 127.0 . 0.1 ) port 8000 (# 0 )
> GET /api/v1/json/json1/ HTTP/ 1.1
> Host: 0 : 8000
> User-Agent: curl/ 7.58 . 0
> Accept: */*
> Authorization: bearer <токен пользователя>
> If-None-Match: "<идентификатор ETag>"
> X-Delta: auto
>
...
< Content-Type: application/json; charset=utf- 8
< ETag: "<идентификатор ETag>"
< Expires: Fri, 30 Mar 2018 13 : 34 : 33 GMT
< Last-Modified: Fri, 30 Mar 2018 12 : 34 : 33 GMT
< Content-Version: delta v1-v4
...
[{ "name" : "table_name1" , "insert_rows" : <строки таблицы>, "delete_ids" : [ 3, 7 , 10 ]},
{ "name" : "table_name2" , "insert_rows" : <строки таблицы>, "delete_ids" : [ 3 , 7, 10 ]}]

В ответе дельта возвращает строки, которые необходимо вставить в сохраненную таблицу, и идентификаторы строк, которые необходимо удалить:

[
   {
     "name" : "table_name1" ,
     "insert_rows" : <строки таблицы>,
     "delete_ids" : [ 3 , 7 , 10 ]
   },
   {
     "name" : "table_name2" ,
     "insert_rows" : <строки таблицы>,
     "delete_ids" : [ 3 , 7 , 10 ]
   }
]

Примечание. Если кэш не изменился, то значения возвращаемых параметров «insert_rows» и «delete_ids» будут пустыми.

При использовании кэширования возможна загрузка кэша при разрыве соединения. Перед выполнением запроса определите токен пользователя.

Запрос должен использовать заголовок X-Range в сочетании с If-Range и Range, где N – номер байта, на котором прервалась передача данных:

curl -v '<IP-адрес или DNS-имя сервера>/api/v1/rpc/<название ресурса>/' -H 'Authorization: Bearer '<токен пользователя> --header 'Content-Type: application/json' --header 'X-Range: bytes=<N>' --header 'If-Range:"<идентификатор ETag>"' --header 'Range: bytes=<N>' --header 'If-Match: "<идентификатор ETag>"' -d '{"<имя входного параметра>": "<значение входного параметра>"}'

Пример ответа, начиная с байта N:

* Trying 0.0.0.0...
* TCP_NODELAY set
* Connected to <имя сервера> (0.0.0.0) port 80 (#0)
> GET /api/v1/rpc/<имя ресурса>/ HTTP/1.1
> Host: <имя сервера>
> User-Agent: curl/7.61.1
> Accept: */*
> Authorization: Bearer <токен пользователя>
> Content-Type: application/json
> X-Range: bytes=<N>-
> If-Range: "<идентификатор ETag>"
> Range: bytes=<N>-
> If-Match: "<идентификатор ETag>"
>
< HTTP/1.1 206 Partial Content
< Server: nginx/1.9.11
< Date: <дата>
< Content-Type: application/json; charset=utf-8
< Transfer-Encoding: chunked
< Connection: keep-alive
< ETag: "<идентификатор ETag>"
< Expires: <дата>
< Last-Modified: <дата>
< Content-Version: 12
< Vary: Accept, Cookie, Accept-Encoding
< Allow: GET, POST, HEAD, OPTIONS
< X-Frame-Options: SAMEORIGIN
< Content-Range: bytes <N>-/*

Получение данных источника данных Foresight

Для получения среза данных на мобильном устройстве используйте API-запросы с указанием параметров. Доступ к данным источника данных Foresight зависит от прав доступа пользователя. Аутентификация пользователя выполняется в соответствии с учетными данными продукта «Форсайт. Аналитическая платформа».

В примерах используются названия ресурсов, заданные при импорте в поле «Название для мобильного клиента», например, «Dictionary», «NSI_param», «Cube», «GrCube».

curl -v "http://localhost/api/v1/rpc/Dictionary/" -H "Authorization: Bearer token" -H "Content-Type: application/json" -H "X-Delta: auto" -d "{"param_LEN": "9" , "param_DIAM": "5" ,"param_PROD":"[[33],[34]]" , "group": null, "attributes": [[]]}"

curl -v "http://localhost/api/v1/rpc/NSI_param/" -H "Authorization: Bearer token" -H "Content-Type: application/json" -H "X-Delta: auto" -d "{"param_LEN": "9" , "param_DIAM": "5" ,"param_PROD":"34" , "group": null, "attributes": [[]]}"

Примечание. Для справочников НСИ доступна отметка только одного элемента.

curl -v "http://localhost/api/v1/rpc/Cube/" -H "Authorization: Bearer token" -H "Content-Type: application/json" -H "X-Delta: auto" -d '{"dim_FACTS": null, "dim_OBJ195219": null, "group": null, "dim_OBJ195221": null, "dim_OBJ195223": null}'

curl -v "http://localhost/api/v1/rpc/Cube/" -H "Authorization: Bearer token" -H "Content-Type: application/json" -H "X-Delta: auto" -d "{"dim_FACTS ": null, "dim_OBJ195219 ": [[ "1 "],[ "2 "]], "group ": null, "dim_OBJ195221 ": null, "dim_OBJ195223 ": null}"

curl -v "http://locslhost/api/v1/rpc/GrCube/" -H "Authorization: Bearer token" -H "Content-Type: application/json" -H "X-Delta: auto" -d "{"dim_BALANCEINDICATORS_DICT":null, "dim_FACTSBUHBALANSE":null, "dim_REGISTRYSTRUCTURE_DICT":null, "dim_CALENDAR":null, "group": [["","","OBJ173485",""]]}"