/v2/Api/DataTablesDeleteRows/


Позволяет удалить существующие строки используя метод HTTP POST. Можно удалять строки на основании фильтров.

ВАЖНО!
Осторожно используйте настройки фильтров. При неправильном использовании фильтров вы можете потерять важные данные.


Формат запроса

Параметры запроса:

ПараметрТипОписание
ApiKeystringВаш API-ключ, необходим для аутентификации. Обязательный.
TableNamestringИмя таблицы данных. Обязательный.
FilterscomplexНабор фильтров. Равняется запросу SQL "WHERE". Обязательный.

Элементы тега Filters:

ПараметрТипОписание
NamestringИмя столбца. Обязательный.
OperatorstringОператор. Обязательный. Может принимать значение:
  • EQ (равно, "="). По умолчанию
  • GT (больше чем, ">")
  • LT (меньше чем, "<")
  • GE (больше или равно, ">=")
  • LE (меньше или равно, "<=")
ValuestringЗначение. Обязательный. Смотрите ниже поддерживаемые типы.

Поддерживаемые типы значений:

  • Text, например, foobar
  • Number, например, 123
  • Double, например, 12.3
  • Date, формат YYYY-MM-DD, например, 2015-11-26
  • Datetime, формат YYYY-MM-DD hh:mm:ss, например, 2015-11-26 12:00:00
  • Boolean, например, true, false, 1, 0

Ответ

Элементы тега Count в ответе:

Элемент/атрибутТипОписание
CountintКоличество удаленных записей.

Примеры


Запрос (удаление записей основанное на фильтрах)

POST https://api.esv2.com/v2/Api/DataTablesDeleteRows/ HTTP/1.1
Accept-Encoding: gzip,deflate
User-Agent: Jakarta Commons-HttpClient/3.1
Host: api.esv2.com
Content-Length: 269

<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <ApiKey>MyTestApiKey</ApiKey>
   <TableName>MyTable</TableName>
   <Filters>
       <Filter>
            <Column>
                <Name>id</Name>
                <Operator>LE</Operator>
                <Value>8</Value>
             </Column>
        </Filter>
        <Filter>
            <Column>
                 <Name>bool2</Name>
                 <Operator>EQ</Operator>
                 <Value>1</Value>
             </Column>
        </Filter>
   </Filters>
</ApiRequest>

Приравнивается к SQL запросу:

DELETE FROM MyTable WHERE id <= 8 AND bool2 = 1

OK ответ:

HTTP/1.1 200 OK
Cache-Control: private
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 28 Oct 2009 15:35:17 GMT
Content-Length: 0

<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Count>1</Count>
</ApiResponse>

Ответ с ошибкой:

HTTP/1.1 400 Bad Request
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 28 Oct 2009 11:32:07 GMT
Content-Length: 239

<ApiResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <ErrorMessage>
      <Code>400</Code>
      <Message>No row matching specified criteria was found.</Message>
   </ErrorMessage>
</ApiResponse>