Back to API references

SOAP API method Export_setSource

Description

The source is either a database, view, collection or miniview, or a combination of a database/view and collection/miniview. When the source is changed, the fields of the export may be reset, if the fields that were already linked to the export came from a different database or collection.

Parameters

Name Type Description
id * int Unique identifier (id) of the object Export. The method only applies to the export with this id.
database Structure of type 'database'
view Structure of type 'view'
miniview Structure of type 'miniview'
collection Structure of type 'collection'
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

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

Name Type Description
id int The ID of the miniview.
name string The name of the miniview.
description string The description of the miniview.
buildstatus string The status of the rebuild
countsubprofiles int The number of subprofiles.

Structure 'collection'

Name Type Description
id int The ID of the collection.
name string The name of the collection.
weight int The weight of the collection.
created string The date and time when the account was created.
unsubscribebehavior string Get the unsubscribe behavior of the collection. Possible values are 'nothing', 'remove' or 'update'.
countsubprofiles int The number of subprofiles.

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