Ваш надежный дом для данных

QuintaDB REST API: обновление и удаление выбранных или всех записей, выполнение действий через api

Про новые возможности QuintaDB API

В этой статье вы узнаете про новые функции QuintaDB API.

Ниже представлены последние обновления.

 

Получить записи

Наш сервис предлагает уникальную возможность - получение до 15 000 записей всего одним API-запросом! Данная функция, поможет значительно расширить потенциал вашего бизнес-приложения.
Узнать подробнее и посмотреть инструкцию можно по этой ссылке.

 

Обновление нескольких записей

Новый запрос для обновления сразу нескольких записей. Этот запрос поможет вам оптимизировать рабочий процесс и сэкономить количество api-запросов.

Чтобы его использовать, достаточно передать параметры dtype_ids, или json_dtype_ids (в случае необходимости передачи параметров в формате JSON) с id записей для обновления.

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

Тело запроса:
{rest_api_key: "API_KEY",
confirm_action: "update",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
json_dtype_ids: "[\"ID1\",\"ID2\"...]",
update_id: "UPDATE_ID",
update_term: "UPDATE_TERM"}

URL
/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Где:

update_id - id колонки для обновления.

update_term - новое значение колонки.

Важно: используйте параметр - confirm_action: "update".

Используемый метод - POST

 

Обновление всех записей

Теперь у вас появилась возможность обновить все записи одним запросом. Аналогично с обновлением нескольких записей.

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

Тело запроса:
{rest_api_key: "YOUR_KEY",
confirm_action: "update_all",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
update_id: "UPDATE_ID",
update_term: "UPDATE_TERM"}

URL
/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Где:

update_id - id колонки для обновления.

update_term - новое значение колонки.

Важно: используйте параметр - confirm_action: "update_all".

Используемый метод - POST

Удаление нескольких записей

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

Для выполнения запроса используются параметры: dtype_ids, или json_dtype_ids.

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

Тело запроса:
{rest_api_key: "YOUR_KEY",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
json_dtype_ids: "[\"ID1\",\"ID2\"...]"}

URL
/apps/APP_ID/dtypes/delete_multiple.json

 

Используемый метод - POST

Удаление всех записей

Для удаления всех записей нет необходимости в дополнительных параметрах, нужно только передать правильный url и тело запроса с вашим API ключем и id формы.

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

Тело запроса:

{rest_api_key: "YOUR_KEY",
entity_id: "ENTITY_ID"}

URL:

/dtypes/APP_ID/delete_all/ENTITY_ID.json

Где:

APP_ID - идентификатор базы данных. 

ENTITY_ID - идентификатор формы.

Используемый метод - DELETE

Выполнить действие

Теперь используя API-запросы вы можете запустить выполнение задачи из поля Действие. Например, запустить e-mail рассылку или обновление записи.

Для запуска действия необходимо подставить id вашего поля (Действие) в URL и передать в теле запроса id записи.

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

Тело запроса:
{"rest_api_key":"API_KEY",
"dtype_id": "DTYPE_ID"}

URL
/actions/ACTION_PROPERTY_ID.json

Где:

DTYPE_ID - идентификатор записи. ID можно найти получив все записи.

ACTION_PROPERTY_ID -  идентификатор поля (Действие). Вы можете найти PROPERTY_ID получив все поля формы.

Используемый метод - GET

Выполнить действия (несколько или все)

Также вы можете запустить сразу несколько действий в вашей таблице. По аналогии с обновлением и удалением нескольких записей используйте параметры: dtype_ids, или json_dtype_ids.

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

Тело запроса:
{"rest_api_key":"API_KEY",
"dtype_ids": ["ID1","ID2"...]}

URL:
/actions/ACTION_PROPERTY_ID.json

 

Для запуска сразу всех действий в таблице или отчете используйте параметр - run_by_all_table_or_report: true.

Тело запроса:
{"rest_api_key":"API_KEY",
"run_by_all_table_or_report": true}

Где:

ACTION_PROPERTY_ID - идентификатор поля (Действие). Вы можете найти PROPERTY_ID получив все поля формы.

Используемый метод - GET


 


Посмотреть все возможности