SOAP API method Rule_copy

Back to API references

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
Parameter 'id' : int
Unique identifier (id) of the object Rule. The method only applies to the rule with this id.
Parameter 'name' : string
The name of the new rule
Parameter 'view' : Structure of type 'view'
The future parent of the new rule, if omitted the same parent as this rule.
Parameter 'options' : Collection of type 'options'
Extra copy options.
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'rule' : Structure of type 'rule'
Return value 'value' : boolean

Structure 'view'
This structure view was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the view.
Property 'name' : string
The name of the view.
Property 'description' : string
The description of the view.
Property 'archived' : boolean
The view is archived.
Property 'buildstatus' : string
The status of the rebuild
Property 'countprofiles' : int
The number of profiles.
Property 'lastbuilt' : timestamp
When was the profile rebuilt for the last time?

Structure 'options'
This structure options was mentioned above. This structure has the following properties:
Property '' : string

Structure 'login'
This structure login was mentioned above. This structure has the following properties:
Property 'username' : string
The username of the login attempt
Property 'account' : string
The account name of the login attempt
Property 'password' : string
The password for the login attempt

Structure 'rule'
This structure rule was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the rule.
Property 'name' : string
The name of the rule.
Property 'inversed' : boolean
Is this rule an inversed rule?
Property 'disabled' : boolean
Is this rule disabled?