SOAP API method View_copy

Back to API references

Description
Make a copy of this view, with a new name. When a array to the 4th parameter is given, all objects that failed to copy will be added to the array. Possible copy options: force: Always return a object, even when some of the childs failed to copy. views: copy the views. exactlinks: Copy links to other miniviews exactly, don't relink them to the newly copied miniview rerefer: Make sure to re-refer any conditions pointing to the original view to now instead refer to the created copy

Parameters
Parameter 'id' : int
Unique identifier (id) of the object View. The method only applies to the view with this id.
Parameter 'name' : string
Name of the new view or the view object itself
Parameter 'view' : Structure of type 'view'
Name of the new view or the view object itself
Parameter 'view' : Structure of type 'view'
Parent of the new view, if omitted the same as this parent.
Parameter 'database' : Structure of type 'database'
Parent of the new view, if omitted the same as this parent.
Parameter 'options' : Collection of type 'options'
Extra options for the copy
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'view' : Structure of type 'view'
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 '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 'database'
This structure database was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the database.
Property 'name' : string
The name of the database.
Property 'description' : string
The description of the database.
Property 'archived' : boolean
The database is archived.
Property 'created' : timestamp
The date and time when the account was created.
Property 'unsubscribebehavior' : string
Get the unsubscribe behavior of the database. Possible values are 'nothing', 'remove' or 'update'.
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 '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?