SOAP API method Database_createImport

Back to API references

Description
Create an import on the database. An import is to fill the database by an external file. Usually it is a tab-delimited file, but the delimiter can be set.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object Database. The method only applies to the database with this id.
Parameter 'name' : string
Name of the import. This is the name by which the users can identify the import: for example the original filename
Parameter 'source' : string
Source of the import, this is a url from a remote location using one of the http, https, ftp, ftps, or sftp protocols. If the url isn't set the data has to be added using the addData method. For internal calls (from PxPublisher) it is also possible to pass a PxFile object.
Parameter 'delimiter' : string
Delimiter in the file, default is tab
Parameter 'privatekey' : string
Private key to login with when using sFTP when login credentials are not used.
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'import' : Structure of type 'import'
Could also be false if something went wrong

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 'import'
This structure import was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the import.
Property 'status' : string
The status of the import.
Property 'laststarttime' : timestamp
The time when the import was started.
Property 'nextstarttime' : timestamp
The time when the next import starts.
Property 'strange' : boolean
Is the input 'strange'?.
Property 'type' : string
The type of the import.
Property 'deletetarget' : string
Set the delete target
Property 'ignoreemptyfields' : boolean
Should empty fields be ignored in the import?
Property 'removemissing' : boolean
Should the missing profiles or subprofiles be removed?.
Property 'name' : string
The name of the import.
Property 'repeatable' : boolean
Can this import be used as a periodic import?.
Property 'delimiter' : string
The delimter to seperate the columns in the data.
Property 'countlines' : int
The number of lines in the import.
Property 'countprocessed' : int
The number of lines that are already processed.
Property 'maxmatches' : int
The max amount of matches there will be changed if there are more profiles/subprofiles.
Property 'datetimeformat' : string
The source format of datetime fields in the import file
Property 'rebuilding' : boolean
Setting that indicates if the database should be rebuilt afterwards
Property 'notification' : string
Returns a string containing one or more e-mail addresses that