SOAP API method MiniRule_copy
Description
When a miniview 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. exactlinks: Copy links to other miniviews exactly, don't relink them to the newly copied miniview
Parameters
Name | Type | Description |
---|---|---|
id * | int | Unique identifier (id) of the object MiniRule. The method only applies to the minirule with this id. |
name * | string | The name of the new MiniRule. |
miniview | Structure of type 'miniview' | The parent for the new miniRule, when omitted the same parent as this minirule will be used. |
options | Collection of type 'options' | The 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 |
---|---|---|
minirule | Structure of type 'minirule' | |
value | boolean |
Structure 'miniview'
Name | Type | Description |
---|---|---|
id | int | The ID of the miniview. |
name | string | The name of the miniview. |
description | string | The description of the miniview. |
buildstatus | string | The status of the rebuild |
countsubprofiles | int | The number of subprofiles. |
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 'minirule'
Name | Type | Description |
---|---|---|
id | int | The ID of the minirule. |
name | string | The name of the minirule. |
inversed | boolean | Is this minirule an inversed minirule? |
disabled | boolean | Is this minirule disabled? |