SOAP API method Database_copy

Back to API references

Description
When a array to the 3rd parameter is given, all objects that failed to copy will be added to the array. Make a copy of this database, with a new name. Possible copy options: structure: copy the structure and properties of the database force: Always return a object, even when some of the childs failed to copy. collections: Copy the collections miniviews: Copy the miniviews views: Copy the views. profiles: copy the profiles. subprofiles: copy the subprofiles (can only be copied if the profiles are copied as well). exactlinks: Copy links to other (mini)views exactly, don't relink them to the newly copied (mini)view

Parameters
Parameter 'id' : int
Unique identifier (id) of the object Database. The method only applies to the database with this id.
Parameter 'database' : Structure of type 'database'
The database or Name of the new database
Parameter 'target' : string
The database or Name of the new database
Parameter 'options' : Collection of type 'options'
Options for the copying of the database.
Parameter 'login' : Structure of type 'login'
Optional login data

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

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 '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?