valuemap.delete

Description

object valuemap.delete(array valuemapids)

This method allows to delete value maps.

This method is only available to Super admin user type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(array) IDs of the value maps to delete.

Return values

(object) Returns an object containing the IDs of the deleted value maps under the valuemapids property.

Examples

Deleting multiple value maps

Delete two value maps.

Request:

{
           "jsonrpc": "2.0",
           "method": "valuemap.delete",
           "params": [
               "1",
               "2"
           ],
           "auth": "57562fd409b3b3b9a4d916d45207bbcb",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "valuemapids": [
                   "1",
                   "2"
               ]
           },
           "id": 1
       }

Source

CValueMap::delete() in ui/include/classes/api/services/CValueMap.php.

Documentation