RestDataSource

Источник данных представления для произвольных http-сервисов данных.

Syntax

new RestDataSource(parameters)

Parameters

Name Type Description
parameters Object Объект с параметрами представления. Один из параметров обязательный: parameters.view - родительское представление источника данных

Properties

Нет

Specific Properties

Для работы с данными свойствами используйте методы getProperty и setProperty.

Обратите внимание, что для работы с данными свойствами необходимо указывать точку в названии.

Name Description
urlParams.get Параметры запроса на получение данных
urlParams.set Параметры запроса на сохранение данных
urlParams.delete Параметры запроса на удаление

urlParams Format

Параметры запроса хранятся в виде объекта со следующими полями:

Name Type Description
origin String1 Хост и порт
path String1 Строка пути (относительно хоста)
method String Метод запроса
data Object1 Данные запроса
params Object Параметры запроса

1 Шаблонизируемая величина.

Parameters Templating

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

Для этого в RestDataSource введены параметры. Вы можете задать значение параметра в свойстве params. А затем использовать его в шаблонизируемых величинах, обозначив <%[paramName]%>.

Например, задан параметр userId, тогда в свойстве path можно обратится к нему следующим образом: "/users?filter=eq(userId,<%userId%>)". При отправке запроса вместо <%userId%> будет установлено соответсвующее значение параметра.

RestDataSource.setGettingUrlParams('params.userId', '12345');
RestDataSource.setGettingUrlParams('path', '/users?filter=eq(userId,<%userId%>)');

Methods

Name Description
getGettingUrlParams Возвращает параметры запроса на получение данных
setGettingUrlParams Устанавливает параметры запроса на получение данных
getSettingUrlParams Возвращает параметры запроса на сохранение данных
setSettingUrlParams Устанавливает параметры запроса на сохранение данных
getDeletingUrlParams Возвращает параметры запроса на удаление
setDeletingUrlParams Устанавливает параметры запроса на удаление
setUpdatingItemsConverter Устанавливает конвертер ответа http-сервиса в контейнер элементов источника данных

Events

Нет

RestDataSource.metadata

Метаданные RestDataSource.

Properties

Name Type Description
GettingParams Object Параметры запроса на получение данных
SettingParams Object Параметры запроса на сохранение данных
DeletingParams Object Параметры запроса на удаление

Examples

{
    "RestDataSource": {
        "GettingParams": {
            "Method": "Get",
            "Origin": "http://<%ip%>:<%port%>",
            "Path": "/documents/<%document%>",
            "Data": {
              "filter": "eq(_id,'<%_id%>')"
            },
            "Params": {
              "ip": "localhost",
              "port": "9900",
              "document": "Patients",
              "_id": "73eba46a-0c6f-42d3-8a7b-2962f0fbf06d"
            }
        },
        "SettingParams": {
            "Method": "Post",
            "Origin": "http://<%ip%>:<%port%>",
            "Path": "/documents/edit/<%document%>",
            "Data": {
              "newValue": "<%patinet%>"
            },
            "Params": {
              "ip": "localhost",
              "port": "9900",
              "document": "Patient",
              "patinet": {
                    "Source": "MainDataSource",
                    "Property": "$"
                }
            }
        },
        "DeletingParams": {
            "Method": "Delete",
            "Origin": "http://<%ip%>:<%port%>",
            "Path": "/documents/delete/<%document%>",
            "Data": {
              "filter": "eq(_id,'<%_id%>')"
            },
            "Params": {
              "ip": "localhost",
              "port": "9900",
              "document": "Patients",
              "_id": "73eba46a-0c6f-42d3-8a7b-2962f0fbf06d"
            }
        }
    }
}