SOAP API method Database_copy
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
Name | Type | Description |
---|---|---|
id * | int | Unique identifier (id) of the object Database. The method only applies to the database with this id. |
database | Structure of type 'database' | The database or Name of the new database |
target | string | The database or Name of the new database |
options | Collection of type 'options' | Options for the copying of the database. |
login | Structure of type 'login' | Optional login data (soon deprecated) |
access_token | string | Optional api access token |
* required parameters |
Return values
Name | Type | Description |
---|---|---|
database | Structure of type 'database' | |
value | boolean |
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 '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? |