Jasper v2

Примечание

• В API Jasper v2 реализована возможность получения определенных полей объектов.

• Также реализована возможность получения ответа в форматах JSON и XML.

Чтобы получить ответ в формате JSON в header запроса необходимо указать:

Content-Type: application/json
Accept: application/json

Чтобы получить ответ в формате XML в header запроса необходимо указать:

Content-Type: application/json
Accept: application/xml

Примечание

Получение информации по объектам, у которых имеются SR-связи, имеют высокие временные затраты. Чтобы ускорить ответ, необходимо указать в теле запроса только требуемые поля, чтобы исключить SR-связь.

Получение списка объектов

Для получения списка объектов необходимо выполнить POST-запрос:

https://{APIURL}/api/v2/entities/{schemeId}/{typeAlias}

В результате запроса будут получены первые 100 объектов с их полями. Управлять количеством объектов и страниц можно с помощью query параметров count и start.

Например:

https://{APIURL}/api/v2/entities/{schemeId}/{typeAlias}?count=4&start=0

В теле запроса можно указать только требуемые поля с уровнями вложенности, используя параметр paths.

При формировании пути необходимо указывать алиас LVItem, алиас LV указывать не нужно. Если хотя бы у одного из типов не будет предоставлено прав доступа, то ответ не будет получен.

Например:

{
   "paths":
   [
   "AdrCapitalBuild/WfAdrPointActiveView/AdrPoint/KeyField",
   "AdrCapitalBuild/Geometry",
   "AdrCapitalBuild/OriginalGeometry"
   ]
}

Чтобы отфильтровать поля, можно использовать параметр filter:

Например:

{
    "filter": {
        "operator": "and",
        "criterions": [
            {
                "operator": "eq",
                "property": {
                    "alias": "m_Street",
                    "type": "field"
                },
                "value": "Рощинская"
            }
        ]
    }
}

Параметр filter можно использовать вместе с требуемыми полями.

Внутри параметра filter необходимо добавить критерии поиска объектов Системы в формате Json. Формат критериев должен содержать в себе корневой элемент {«operator»: «operator», «criterions»:[]}.

Например:

{
    "paths":
    [
    "AdrCapitalBuild/WfAdrPointActiveView/AdrPoint/KeyField",
    "AdrCapitalBuild/Geometry",
    "AdrCapitalBuild/OriginalGeometry"
    ],
    "filter": {
        "operator": "and",
        "criterions": [
            {
                "operator": "eq",
                "property": {
                    "alias": "m_Street",
                    "type": "field"
                },
                "value": "Рощинская"
            }
        ]
    }
}

Дополнительную информацию по параметрам смотрите в разделе Поиск и получение объектов из Системы.

Получение объекта по ключу

Для получения объекта по ключу необходимо выполнить POST-запрос:

https://{APIURL}/api/v2/entities/{schemeId}/{typeAlias}/{ид объекта}/

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

Например:

 [
"AdrCapitalBuild/Geometry",
"AdrCapitalBuild/OriginalGeometry",
"AdrCapitalBuild/DetoriorationRate",
"AdrCapitalBuild/StroyObyem",
 ]