action.update

说明

object action.update(object/array actions)

此方法允许更新现有的动作。

参数

(object/array) 要更新的动作属性。

必须为每个动作定义 actionid 属性，所有其他属性都是可选的。只有通过的属性将被更新，所有其他属性将保持不变。

除此之外 standard action properties, 该方法接受以下参数。

返回值

(object) 返回一个对象，该对象在 actionids 属性下包含要更新动作的 ID。

范例

禁用动作

禁用动作，也就是说，将其状态设置为 1。

请求:

{
           "jsonrpc": "2.0",
           "method": "action.update",
           "params": {
               "actionid": "2",
               "status": "1"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应:

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

参见

• Action filter
• Action operation

来源

CAction::update() in frontends/php/include/classes/api/services/CAction.php.

Description

object action.update(object/array actions)

This method allows to update existing actions.

Parameters

(object/array) Action properties to be updated.

The actionid property must be defined for each action, all other properties are optional. Only the passed properties will be updated, all others will remain unchanged.

Additionally to the standard action properties, the method accepts the following parameters.

Return values

(object) Returns an object containing the IDs of the updated actions under the actionids property.

Examples

Disable action

Disable action, that is, set its status to "1".

Request:

{
           "jsonrpc": "2.0",
           "method": "action.update",
           "params": {
               "actionid": "2",
               "status": "1"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

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

See also

• Action filter
• Action operation

Source

CAction::update() in frontends/php/include/classes/api/services/CAction.php.