manual:api:reference:regularexpression:delete

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
manual:api:reference:regularexpression:delete [2021/09/14 11:02]
robertsl removed
— (current)
Line 1: Line 1:
-===== regexp.delete ===== 
  
-==== Description ==== 
- 
-''​object regexp.delete(array **regexpids**)''​ 
- 
-This method allows to delete global regular expressions. 
- 
-<​note>​This method is only available to //Super admin// user types. Permissions to call the method can be revoked in user role settings. See [[:​manual/​web_interface/​frontend_sections/​administration/​user_roles|User roles]] for more information.</​note>​ 
- 
-==== Parameters ==== 
- 
-''​(array)''​ IDs of the regular expressions to delete. 
- 
-==== Return values ==== 
- 
-''​(object)''​ Returns an object containing the IDs of the deleted regular expressions under the ''​regexpids''​ property. 
- 
-==== Examples ==== 
- 
-=== Deleting multiple global regular expressions. === 
- 
-Request: 
-<code java> 
-{ 
-    "​jsonrpc":​ "​2.0",​ 
-    "​method":​ "​regexp.delete",​ 
-    "​params":​ [ 
-        "​16",​ 
-        "​17"​ 
-    ], 
-    "​auth":​ "​3a57200802b24cda67c4e4010b50c065",​ 
-    "​id":​ 1 
-} 
-</​code>​ 
- 
-Response: 
-<code java> 
-{ 
-    "​jsonrpc":​ "​2.0",​ 
-    "​result":​ { 
-        "​regexpids":​ [ 
-            "​16",​ 
-            "​17"​ 
-        ] 
-    }, 
-    "​id":​ 1 
-} 
-</​code>​ 
- 
-==== Source ==== 
- 
-CRegexp::​delete() in //​ui/​include/​classes/​api/​services/​CRegexp.php//​.