{"id":3747,"date":"2023-08-31T08:12:31","date_gmt":"2023-08-31T07:12:31","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3747"},"modified":"2024-03-19T13:24:34","modified_gmt":"2024-03-19T12:24:34","slug":"delete-row","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/data-tables\/delete-row\/","title":{"rendered":"Delete row"},"content":{"rendered":"\n

DataTablesDeleteRow collection allows deleting existing rows using HTTP POST method. It is only possible to delete a single row with one request by specifying its unique identifier (PK, primary key).<\/p>\n\n\n\n

<\/a><\/a>Request data format<\/strong><\/h3>\n\n\n\n

Request URL parameters:<\/p>\n\n\n\n

Parameter<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
ApiKey<\/td>string<\/td>Your API key, required for authentication. Required.<\/td><\/tr>
TableName<\/td>string<\/td>Name of Data Table. Required.<\/td><\/tr>
PrimaryKeyColumns<\/td>complex<\/td>Collection of Column elements. Contains unique identifier (PK, primary key) of the row that is supposed to be updated. This is an equivalent of SQL “WHERE” directive. Required.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Column element children:<\/p>\n\n\n\n

Parameter<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Name<\/td>string<\/td>Column name. Required.<\/td><\/tr>
Value<\/td>string<\/td>Field value. Required.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Examples<\/strong><\/h3>\n\n\n\n

Request (deleting a record from table with simple PK):<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
POST https:\/\/api.esv2.com\/v2\/Api\/DataTablesDeleteRow\/ HTTP\/1.1<\/span><\/span>\nAccept-Encoding: gzip,deflate<\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1<\/span><\/span>\nHost: api.esv2.com<\/span><\/span>\nContent-Length: 269<\/span><\/span>\n<\/span>\n<<\/span>ApiRequest<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xs<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>ApiKey<\/span>><\/span>test_api_key1<\/span><\/<\/span>ApiKey<\/span>><\/span><\/span>\n   <\/span><<\/span>TableName<\/span>><\/span>Table1<\/span><\/<\/span>TableName<\/span>><\/span><\/span>\n   <\/span><<\/span>PrimaryKeyColumns<\/span>><\/span><\/span>\n     <\/span><<\/span>Column<\/span>><\/span><\/span>\n        <\/span><<\/span>Name<\/span>><\/span>Id<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n        <\/span><<\/span>Value<\/span>><\/span>1<\/span><\/<\/span>Value<\/span>><\/span><\/span>\n     <\/span><\/<\/span>Column<\/span>><\/span><\/span>\n   <\/span><\/<\/span>PrimaryKeyColumns<\/span>><\/span><\/span>\n<\/<\/span>ApiRequest<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 204 No Content<\/span><\/span>\nCache-Control: private<\/span><\/span>\nServer: Microsoft-IIS\/7.5<\/span><\/span>\nX-AspNetMvc-Version: 1.0<\/span><\/span>\nX-AspNet-Version: 2.0.50727<\/span><\/span>\nX-Powered-By: ASP.NET<\/span><\/span>\nDate: Wed, 28 Oct 2009 15:35:17 GMT<\/span><\/span>\nContent-Length: 0<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Error response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 400 Bad Request<\/span><\/span>\nCache-Control: private<\/span><\/span>\nContent-Type: text\/xml; charset=utf-8<\/span><\/span>\nServer: Microsoft-IIS\/7.5<\/span><\/span>\nX-AspNetMvc-Version: 1.0<\/span><\/span>\nX-AspNet-Version: 2.0.50727<\/span><\/span>\nX-Powered-By: ASP.NET<\/span><\/span>\nDate: Wed, 28 Oct 2009 11:32:07 GMT<\/span><\/span>\nContent-Length: 239<\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>ErrorMessage<\/span>><\/span><\/span>\n      <\/span><<\/span>Code<\/span>><\/span>400<\/span><\/<\/span>Code<\/span>><\/span><\/span>\n      <\/span><<\/span>Message<\/span>><\/span>No row matching specified criteria was found.<\/span><\/<\/span>Message<\/span>><\/span><\/span>\n   <\/span><\/<\/span>ErrorMessage<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Request (deleting a record from table with composite\/multicolumn PK):<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
POST https:\/\/api.esv2.com\/v2\/Api\/DataTablesDeleteRow\/ HTTP\/1.1<\/span><\/span>\nAccept-Encoding: gzip,deflate<\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1<\/span><\/span>\nHost: api.esv2.com<\/span><\/span>\nContent-Length: 321<\/span><\/span>\n<\/span>\n<<\/span>ApiRequest<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xs<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>ApiKey<\/span>><\/span>test_api_key1<\/span><\/<\/span>ApiKey<\/span>><\/span><\/span>\n   <\/span><<\/span>TableName<\/span>><\/span>Table1<\/span><\/<\/span>TableName<\/span>><\/span><\/span>\n   <\/span><<\/span>PrimaryKeyColumns<\/span>><\/span><\/span>\n     <\/span><<\/span>Column<\/span>><\/span><\/span>\n        <\/span><<\/span>Name<\/span>><\/span>Column1<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n        <\/span><<\/span>Value<\/span>><\/span>1<\/span><\/<\/span>Value<\/span>><\/span><\/span>\n     <\/span><\/<\/span>Column<\/span>><\/span><\/span>\n     <\/span><<\/span>Column<\/span>><\/span><\/span>\n        <\/span><<\/span>Name<\/span>><\/span>Column2<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n        <\/span><<\/span>Value<\/span>><\/span>value2<\/span><\/<\/span>Value<\/span>><\/span><\/span>\n     <\/span><\/<\/span>Column<\/span>><\/span><\/span>\n   <\/span><\/<\/span>PrimaryKeyColumns<\/span>><\/span><\/span>\n<\/<\/span>ApiRequest<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":3729,"menu_order":264,"template":"","format":"standard","emp-category":[],"class_list":["post-3747","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3747","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es"}],"about":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/types\/es"}],"author":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/users\/5"}],"version-history":[{"count":2,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3747\/revisions"}],"predecessor-version":[{"id":8852,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3747\/revisions\/8852"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3729"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3747"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3747"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}