Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Table API позволяет вам производить операции CRUD (создание, чтение, обновление и удаление) на созданных таблицах.
Запросы CRUD на таблицу Table API выполняются согласно правилам контроля доступам При обработке запросов на операции CRUD посредством Table API учитываются правила контроля доступа (ACL).
Формат URL Table API:
Название | Значение |
---|---|
URL по умолчанию | /rest/v1/table/ |
Авторизация
Два Table API поддерживает два типа запросов на авторизацию поддерживаются для Table API:
- Basic Auth – аутентификация включает в себя отправку запроса с проверенным именем пользователя и паролем.
- Bearer Token –аутентификация – аутентификация с ключом доступа. Токен представляет собой текстовую строку, которая включена в заголовок запроса.
Image Added
Операция CREATE
Используйте метод POST, чтобы создать запись в указанной таблице. Метод не поддерживает создание нескольких записей.
Пример:
Code Block |
---|
POST /rest/v1/table/{tableName} |
Параметры тела запроса
Вы можете указывать указать необходимое количество колонок и их значений.
Параметр | Значение |
---|---|
column_name | column_value |
Используйте следующие параметры с этим методом:
Параметр | Описание |
---|---|
sysparm_display_value | Метод операции для извлечения данных. Может возвращать два типа значенийФлаг, определяющий тип возвращаемых данных. Валидные значения:
Значение по умолчанию: 0. |
sysparm_exclude_reference_link | ФлажокФлаг, указывающий на исключение ссылок Table API ( Валидные значения:
Значение по умолчанию: 0. |
sysparm_fields | Список полей, разделенных запятой, которые должны вернуться в ответе. Пример значения: number,caller. |
sysparm_view | Ответ содержит поля представления формы, указанной в этом параметре. Обратите внимание, что параметр может быть переопределено параметром sysparm_fields Значение по умолчанию: Default. |
Note |
---|
Используйте тело запроса типа raw JSON вместо form-data. |
Параметр поддерживает использование dot-walking.
Пример значения: number,caller.phone | |||
sysparm_view | Представление формы, поля которого должны вернуться в ответе. Обратите внимание, что этот параметр может быть переопределен параметром sysparm_fields. Из набора колонок представления, указанного в sysparm_view, выводятся только те, что указаны в sysparm_fields. Если указаны поля в sysparm_fields, которых нет в выбранном представлении, оно не выведется.
|
Note |
---|
Используйте тело запроса типа raw JSON вместо form-data. |
Image Added
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Section | ||||||||||||||||||||||||
|
Операция READ
Операции чтения в SimpleOne ограничены методом GET.
Для извлечения одной записи из указанной таблицы, используйте следующий шаблон URL:
Code Block GET /rest/v1/table/{tableName}/{sys_id}
Для извлечения нескольких записей, используйте следующий шаблон URL:
Code Block GET /rest/v1/table/{tableName}
Используйте следующие параметры с этим методом:
Параметр | Описание | ||
---|---|---|---|
sysparm_query | Декодированная Закодированная строка запроса, которая используется для фильтрации результатов. Параметр поддерживает использование dot-walking. Пример значения: active=1. Для создания сложного запроса, используйте системные названия операторов и строку условий. | ||
sysparm_display_value | Метод операции для извлечения данных. Может возвращать два типа значенийФлаг, определяющий тип возвращаемых данных. Валидные значения:
Значение по умолчанию: 0. | ||
sysparm_exclude_reference_link | ФлажокФлаг, указывающий на исключение ссылок Table API ( Валидные значения:
Значение по умолчанию: 0. | ||
sysparm_fields | Список полей, разделенных запятой, которые должны вернуться в ответе. Параметр поддерживает использование dot-walking. Пример Пример значения: number,caller.phone | ||
sysparm_view | Ответ содержит поля представления Представление формы, поля которого должны вернуться в ответе. Обратите внимание, что этот параметр может быть переопределен параметром sysparm_fields . | ||
sysparm_limit | Максимальное количество результатов, возвращаемое запросом. Значение по умолчанию: 20. | ||
Из набора колонок представления, указанного в sysparm_view, выводятся только те, что указаны в sysparm_fields. Если указаны поля в sysparm_fields, которых нет в выбранном представлении, оно не выведется.
| |||
sysparm_limit | Максимальное количество результатов, возвращаемое запросом. Значение по умолчанию: 20. | ||
sysparm_page | Номер | sysparm_page | Укажите номер страницы, с которой начнется чтение. Например, если значнение значение параметра sysparm_limit – 40, а у sysparm_page значение равно двум, то ответ будет включать записи 21-6021–60. Значение по умолчанию: 1. |
Note |
---|
Используйте тело запроса типа raw JSON вместо form-data. |
Image Added
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Операция UPDATE
Для операции обновления доступны два метода: PUT и PATCH. PUT содержит новые версии записи, в то время как в PATCH вложенные объекты содержат набор инструкций, которые описывают как записи исходного сервера должны обновляться, чтобы создавать новые версииPUT обновляет запись целиком, при этом любые поля, не включенные в тело запроса, будут перезаписаны значениями null или по умолчанию. PATCH обновляет только те поля, которые указаны в теле запроса, без изменения остальных полей записи.
Параметры тела
Вы можете указывать указать необходимое количество колонок и их значений.
Параметр | Значение |
---|---|
column_name | column_value |
Используйте следующие параметры с этим методом:
Parameter | Description |
---|---|
sysparm_display_value | Метод операции для извлечения данных. Может возвращать два типа значенийФлаг, определяющий тип возвращаемых данных. Валидные значения:
Значение по умолчанию: 0. |
sysparm_exclude_reference_link | ФлажокФлаг, указывающий на исключение ссылок Table API ( Валидные значения:
Значение по умолчанию: 0. |
sysparm_fields | Список полей, разделенных запятой, которые должны вернуться в ответе. Параметр поддерживает использование dot-walking. Пример значения: number,caller.phone |
sysparm_view | Ответ содержит поля представления Представление формы, поля которого должны вернуться в ответе. Обратите внимание, что этот параметр может быть переопределен параметром sysparm_fields Значение по умолчанию: Default. |
Note |
---|
Используйте тело запроса типа raw JSON вместо form-data. |
PUT
Используйте метод для обновления записей в указанной таблице, используя значения, которые определены в теле запроса.
Пример:
. Из набора колонок представления, указанного в sysparm_view, выводятся только те, что указаны в sysparm_fields. Если указаны поля в sysparm_fields, которых нет в выбранном представлении, оно не выведется.
|
Note |
---|
Используйте тело запроса типа raw JSON вместо form-data. |
Image Added
PUT
Используйте метод для обновления записей в указанной таблице, используя значения, которые определены в теле запроса.
Пример:
Code Block | ||
---|---|---|
| ||
PUT / | ||
Code Block | ||
| ||
PUT /rest/v1/table/{tableName}/{sys_id} |
PATCH
Используйте метод для частичного обновления записей. Этот метод обновляет определенную запись в указанной таблице с телом запроса.
Пример:
Code Block |
---|
PATCH /rest/v1/table/{tableName}/{sys_id} |
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
PATCH
Используйте метод для частичного обновления записей. Этот метод обновляет отдельные поля записи в указанной таблице, используя значения, которые определены в теле запроса.
Пример:
Code Block |
---|
PATCH /rest/v1/table/{tableName}/{sys_id} |
Section | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||
|
Операция DELETE
Используйте метод DELETE, чтобы удалять определенную запись удалить из таблицы с телом запросазапись, указанную в запросе.
Пример:
Code Block |
---|
DELETE /rest/v1/table/{tableName}/{sys_id} |
Возможно два типа ответа:
- Запись была успешно удалена.
- Возникла ошибка.
Image Added
Пример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
DELETE /rest/v1/table/sys_filter/166039918402151705 HTTP/1.1 Host: sandbox-01.dev.simpleone.ru Authorization: Bearer 70xlHwLAgSeBKF7Dafbu-lcUrWlvw4eu |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "status": "OK", "data": { "description": "Records successfully deleted." } |
Ответ о возникновении ошибки
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "status": "ERROR", "error_type": "SERVER", "errors": [ { "message": "You have no access to delete this records." } ] } |
Table of Contents | ||||||
---|---|---|---|---|---|---|
|