Back to API references

SOAP API method View_copy

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

Name Type Description
id * int Unique identifier (id) of the object View. The method only applies to the view with this id.
name string Name of the new view or the view object itself
view Structure of type 'view' Name of the new view or the view object itself
view Structure of type 'view' Parent of the new view, if omitted the same as this parent.
database Structure of type 'database' Parent of the new view, if omitted the same as this parent.
options Collection of type 'options' Extra options for the copy
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
view Structure of type 'view'
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 '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 'database'

Name Type Description
id int The ID of the database.
name string The name of the database.
description string The description of the database.
archived boolean The database is archived.
created timestamp The date and time when the account was created.
unsubscribebehavior string Get the unsubscribe behavior of the database. Possible values are 'nothing', 'remove' or 'update'.
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 '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?