Получение данных о конкретной записи

Для получения данных об отдельной записи объекта необходимо выполнить запрос по адресу <hostname>/data/single/<object>/{id} методом GET, в котором:

  • <hostname> – адрес сервиса Blitz REST API Server. Например: http://localhost:8080/api;
  • <object> – объект, к которому относится запись;
  • {id} – идентификатор записи.

Пример запроса на получение данных записи:

GET /api/meta/person/1234 HTTP/1.1
Host: localhost:8080
Cache-Control: no-cache

В качестве ответа возвращается json с данными записи, например:

{
    "cas": 1,
    "gender": "M",
    "id": 1,
    "name": "Ivan Petrov"
}

При наличии связанных (подчиненных) записей у данной записи они также будут выведены. Если необходимо ограничить глубину связанных записей, в GET-запрос качестве query-параметра следует добавить depth={value}, где value – глубина запроса (1 соответствует первому уровню). Пример запроса:

GET /api/meta/person/1234?depth=1 HTTP/1.1
Host: localhost:8080
Cache-Control: no-cache

Добавление записи

Для добавления отдельной записи необходимо выполнить запрос по адресу <hostname>/data/single/<object> методом PUT, в котором:

  • <hostname> – адрес сервиса Blitz REST API Server. Например: http://localhost:8080/api;
  • <object> – объект, к которому относится запись;
  • заголовок Content-Type должен иметь значение “application/json”;
  • в качестве тела запроса указан json с данными записи.

Пример запроса на добавление записи:

PUT /api/data/single/person HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Cache-Control: no-cache

{
    "name": "Test User",
    "gender": "M"
}

В качестве ответа возвращается json с данными добавленной записи, например:

{
    "cas": 1,
    "gender": "M",
    "id": 3,
    "name": "Test User"
}

Изменение записи

Для изменения отдельной записи необходимо выполнить запрос по адресу <hostname>/data/single/<object>/{uid} методом POST, в котором:

  • <hostname> – адрес сервиса Blitz REST API Server. Например: http://localhost:8080/api;
  • <object> – объект, к которому относится запись;
  • {id} – идентификатор записи;
  • заголовок Content-Type должен иметь значение “application/json”;
  • в качестве тела запроса указан json с новыми данными записи.

Пример запроса на изменение записи:

POST /api/data/single/person/1234 HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Cache-Control: no-cache

{
    "name": "Test User New",
    "id": 1234,
    "gender": "M"
}

В качестве ответа возвращается json с данными добавленной записи, например:

{
    "cas": 1,
    "gender": "M",
    "id": 1234,
    "name": "Test User New"
}

Чтобы убедиться, что с момента чтения данных записи c ней не произошло никаких изменений, в json с данными следует добавлять атрибут cas, полученный из изменяемой записи. В этом случае при изменении записи:

  • если атрибут cas в запросе не совпадает с атрибутом cas в записи, то изменение не произойдет. Будет возвращена ошибка “cas_failed”;
  • если атрибут cas в запросе совпадает с атрибутом cas в записи, то изменение произойдет, а атрибуту cas будет присвоено новое значение.

Удаление записи

Для удаления отдельной записи необходимо выполнить запрос по адресу <hostname>/data/single/<object>/{uid} методом DELETE, в котором:

  • <hostname> – адрес сервиса Blitz REST API Server. Например: http://localhost:8080/api;
  • <object> – объект, к которому относится запись;
  • {id} – идентификатор записи, которую требуется удалить.

Пример запроса на удаление записи:

DELETE /api/data/single/person/1234 HTTP/1.1
Host: localhost:8080
Cache-Control: no-cache