Skip to content

Latest commit

 

History

History
123 lines (81 loc) · 7.06 KB

crud_get.rst

File metadata and controls

123 lines (81 loc) · 7.06 KB
Raw

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

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

Получение объекта осуществляется методом GET, при этом указывается код класса с нейспейсом и значение ключа объекта, например rest/crud/class_string@develop-and-test/66dbb3d0-5583-11e6-aef7-cf50314f026b

curl -X GET -u demo@local:ion-demo https://dnt.iondv.com/rest/crud/class_string@develop-and-test/66dbb3d0-5583-11e6-aef7-cf50314f026b

Пример запроса к сервису crud для получения объекта в dnt </4_modules/modules/rest/services/services_files/request/request_examples>: test/modules/rest/crud.spec.js

/Checking crud service/GET/# getting an object (GET)

При этом дополнительно в query может быть задан параметр _eager содержащий список свойств класса, разделенных символом | для которых необходимо осуществить жадную загрузку данных (ссылки или коллекции). Например

curl -X GET -u demo@local:ion-demo https://dnt.iondv.com/rest/crud/class_string@develop-and-test/66dbb3d0-5583-11e6-aef7-cf50314f026b?_eager=string_text

Пример запроса к сервису crud для получения объекта с жадной загрузкой свойства "table" в dnt </4_modules/modules/rest/services/services_files/request/request_examples>: test/modules/rest/crud.spec.js

/Checking crud service/GET/# getting an object with eager loading of the "table" property (GET)

Если объект существует - возвращает код ответа 200 и сам объект в формате json, если объект не найден 404, если нет прав 403.

{
    "_id": "66dbb3d0-5583-11e6-aef7-cf50314f026b",
    "__string": "Example of the \"String [0]\" type in the \"Text [1]\" view",
    "__class": "class_string@develop-and-test",
    "__classTitle": "Class \"String [0]\"",
    "id": "66dbb3d0-5583-11e6-aef7-cf50314f026b",
    "string_text": "Example of the \"String [0]\" type in the \"Text [1]\" view",
    "string_miltilinetext": "Example of the \"String [0]\"\r\n in the Multiline text [7] view",
    "string_formattext": "Example of the \r\n \"String [0]\" type \r\n in the \r\nFormatted text [7] view"
}

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

Запрос списка объектов осуществляется методом GET, при этом указывается код класса и нейспейс, например rest/crud/class_string@develop-and-test/

curl -X GET -u demo@local:ion-demo https://dnt.iondv.com/rest/crud/class_string@develop-and-test/

Пример запроса к сервису crud для получения списка объектов в dnt </4_modules/modules/rest/services/services_files/request/request_examples>: test/modules/rest/crud.spec.js

/Checking crud service/GET/# getting a list of text objects

В ответ сервис выдает JSON Объект со смещением 0 и кол-вом 5ть записей и статусом 200, если такого класса нет возвращает код 404.

[{"_creator":"admin@local",
"_id":"4567a830-b8ea-11e9-9cdf-7bd384cbb7a5",
"__string":"example1",
"__class":"class_string@develop-and-test",
"__classTitle":"Class \"String [0]\"",
"id":"4567a830-b8ea-11e9-9cdf-7bd384cbb7a5",
"string_text":"example1",
"string_miltilinetext":"example1",
"string_formattext":"<p>example1</p>"},
{"_id":"66dbb3d0-5583-11e6-aef7-cf50314f026b",
"__string":"Example of the \"String [0]\" type in the \"Text [1]\" view",
"__class":"class_string@develop-and-test",
"__classTitle":"Class \"String [0]\"",
"id":"66dbb3d0-5583-11e6-aef7-cf50314f026b",
"string_text":"Example of the \"String [0]\" type in the \"Text [1]\" view",
"string_miltilinetext":"Example of the \"String [0]\"\r\n in the Multiline text [7] view",
"string_formattext":"Example of the \r\n \"String [0]\" type \r\n in the \r\nFormatted text [7] view"}]

Запрос может быть осуществлен со следущими query параметрами:

  • _offset - смещение выборки, по умолчанию 0
  • _count - кол-во значение в выборке, по умолчанию 5
  • _eager - список свойств класса, разделенных символом | для которых необходимо осуществить жадную загрузку данных.
  • [name of property] - все параметры запроса, кроме начинающихся на _ считаются именами атрибутов класса, а их значения задаются в качестве фильтров.

Примеры:

  1. Запрос списка объектов класса со смещением 1 и кол-вом 2

    curl -X GET -u demo@local:ion-demo https://dnt.iondv.com/rest/crud/class_string@develop-and-test/?_offset=1&_count=2

  2. Запрос списка объектов, у которы свойство string_text имеет значение example1

    curl -X GET -u demo@local:ion-demo https://dnt.iondv.com/rest/crud/class_string@develop-and-test/?string_text=example1

  3. Запрос списка объектов, у которы свойство string_text имеет значение example1, со смещением 1 и кол-вом 2

    curl -X GET -u demo@local:ion-demo https://dnt.iondv.com/rest/crud/class_string@develop-and-test/?string_text=example1&_offset=1&_count=2

Пример запроса к сервису crud для получения списка объектов с различными параметрами сдвига и фильтрации в dnt </4_modules/modules/rest/services/services_files/request/request_examples>: test/modules/rest/crud.spec.js

/Checking crud service/GET/# getting a list of text objects, with an offset of 1 and a count of 2
/Checking crud service/GET/# getting a list of text objects containing a specific string