SOAP API method Rule_copy
Description
When a view given, the copy will be created there. When a array to the 4th parameter is given, all objects that failed to copy will be add to the array. The available options force: Always return a object, even when some of the childs failed to copy.
Parameters
| Name | Type | Description |
|---|---|---|
| id * | int | Unique identifier (id) of the object Rule. The method only applies to the rule with this id. |
| name * | string | The name of the new rule |
| view | Structure of type 'view' | The future parent of the new rule, if omitted the same parent as this rule. |
| options | Collection of type 'options' | Extra copy options. |
| login | Structure of type 'login' | Optional login data (soon deprecated) |
| access_token | string | Optional api access token |
| * required parameters | ||
Return values
| Name | Type | Description |
|---|---|---|
| rule | Structure of type 'rule' | |
| value | boolean |
Structure 'view'
| Name | Type | Description |
|---|---|---|
| id | int | The ID of the view. |
| name | string | The name of the view. |
| description | string | The description of the view. |
| archived | boolean | The view is archived. |
| buildstatus | string | The status of the rebuild |
| countprofiles | int | The number of profiles. |
| lastbuilt | timestamp | When was the item rebuilt for the last time? |
Structure 'options'
| Name | Type | Description |
|---|---|---|
| string |
Structure 'login'
| Name | Type | Description |
|---|---|---|
| username | string | The username of the login attempt |
| account | string | The account name of the login attempt |
| password | string | The password for the login attempt |
Structure 'rule'
| Name | Type | Description |
|---|---|---|
| id | int | The ID of the rule. |
| name | string | The name of the rule. |
| inversed | boolean | Is this rule an inversed rule? |
| disabled | boolean | Is this rule disabled? |