From 86cb8af47e1a08564b0f985d5825016e80794e05 Mon Sep 17 00:00:00 2001 From: Konstantin Krivopustov Date: Fri, 7 Jun 2013 13:38:21 +0000 Subject: [PATCH] Minor fixes in REST API doc --- doc/content/manual/ru/chapter_framework.xml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/content/manual/ru/chapter_framework.xml b/doc/content/manual/ru/chapter_framework.xml index 1e10cb5032..69e600e8bc 100644 --- a/doc/content/manual/ru/chapter_framework.xml +++ b/doc/content/manual/ru/chapter_framework.xml @@ -9982,13 +9982,13 @@ taskHandler.execute();Подробная информац REST API
Общие сведения - Универсальный REST API платформы позволяет выполнять загрузку и сохранение любых сущностей модели данных приложения посредством отправки простых HTTP запросов. Это открывает возможность легкой интеграции со сторонними приложениями самого широкого спектра − от JavaScript кода, выполняющегося в браузере, до произвольных систем, работающих на Java, NET, PHP или любой другой платформе. + Универсальный REST API платформы позволяет выполнять загрузку и сохранение любых сущностей модели данных приложения посредством отправки простых HTTP запросов. Это открывает возможность легкой интеграции со сторонними приложениями самого широкого спектра − от JavaScript кода, выполняющегося в браузере, до произвольных систем, работающих на Java, .NET, PHP или любой другой платформе. Основные возможности API: загрузка экземпляров сущностей из базы данных по идентификатору или по JPQL запросу с параметрами - сохранение новых и измененных экземпляров, удаление + сохранение новых и измененных экземпляров, удаление экземпляров получение описания модели данных в формате HTML @@ -10019,7 +10019,7 @@ taskHandler.execute();Подробная информац
Описание функций При стандартных настройках модуля portal все запросы к REST API должны иметь URL, начинающийся с {host:port}/app-portal/api. - Все функции требуют наличия сессии аутентифицированного пользователя, то есть необходимо выполнить логин. + Все функции требуют наличия сессии аутентифицированного пользователя, то есть сначала необходимо выполнить логин, и передавать полученный идентификатор сессии в последующие запросы.
Логин Логин можно выполнить либо GET, либо POST запросом. @@ -10060,7 +10060,7 @@ locale: en - В ответ сервис вернет userSessionId в теле ответа и статус 200 или статус 401, если аутентификация не удалась. + В ответ сервис вернет userSessionId в теле ответа и статус 200, либо статус 401, если аутентификация не удалась.
Загрузка экземпляра персистентного объекта из базы данных по идентификатору @@ -10073,7 +10073,7 @@ locale: en s − идентификатор текущей сессии. - format задает формат получения результата. Принимает два значения: xml или json. + Элемент запроса format задает формат получения результата. Принимает два значения: xml или json. Пример запроса, возвращающего результат в формате xml: http://localhost:8080/app-portal/api/find.xml?e=sales$Order-60885987-1b61-4247-94c7-dff348347f93-orderWithCustomer&s=c38f6bf4-fae7-4ee6-a412-9d93ff243f23 Пример запроса, возвращающего результат в формате json @@ -10109,11 +10109,11 @@ locale: en Для каждого из передаваемых параметров можно явно указать его тип, добавив в запрос одноименный параметр с суффиксом _type. Например: http://localhost:8080/app-portal/api/query.json?e=sales$Customer&q=select%20c%20from%20sales$Customer%20c%20where%20c.name=:specName&s=748e5d3f-1eaf-4b38-bf9d-8d838587367d&specName=Петров&specName_type=string Указание типа параметра не является обязательным, но позволяет избежать ошибок парсинга, если система не сможет определить тип. - В общем случае тип стоит указывать лишь для строковых параметров, которые по какой-либо причине имеют формат более узких типов (даты, чисел, uuid), но должны интерпретироваться именно как строки. + В общем случае тип стоит указывать лишь для строковых параметров, которые по какой-либо причине имеют формат более узких типов (дат, чисел, uuid), но должны интерпретироваться именно как строки. Список доступных типов можно увидеть в описании мета-модели (пункт меню Помощь −> Модель данных) или получив HTML-описание модели.
- Коммит новых или измененных экземпляров, удаление + Коммит новых и измененных экземпляров, удаление Функция коммита позволяет выполнять операции над переданными ей объектами и возвращает их старое и новое состояния. Формат результата определяется тем, какой формат (JSON или XML) был использован для запроса (заголовок Content-Type). @@ -10135,7 +10135,7 @@ locale: en } Массив commitInstances содержит создаваемые или изменяемые сущности. Для создаваемой сущности в поле id используется префикс NEW-: NEW-<entityName> или NEW-<entityName>-<uuid>. Для модифицируемых сущностей здесь указывается значение <entityName>-<uuid>. Массив removeInstances содержит удаляемые объекты. Перед удалением будет выполнен merge() переданных объектов, что позволяет, например, проверить, не изменилась ли версия удаляемого объекта. - Булевское поле softDeletion говорит о том, что экземпляры будут лишь помечены как удаленные без их реального удаления. + Поле softDeletion управляет режимом мягкого удаления.