SOAP API method Database_createExport

Back to API references

Description
Create a new export. The export is mostly a tab-delimited file, but the delimiter can be supplied as parameter. Not all deliters are supported by the software.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object Database. The method only applies to the database with this id.
Parameter 'delimiter' : string
delimeter of the export, default '\t'
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'export' : Structure of type 'export'

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 'export'
This structure export was mentioned above. This structure has the following properties:
Property 'name' : string
The name of the export.
Property 'description' : string
The description of the export.
Property 'delimiter' : string
The delimiter of the export.
Property 'extension' : string
The extension of the exported file
Property 'charset' : string
The character set of the output file
Property 'bom' : boolean
Is a Byte-Order-Mark (BOM) stored in the first couple of bytes of the
Property 'createdtime' : timestamp
The time when the export was created.
Property 'readytime' : timestamp
The time when the export was ready.
Property 'status' : string
The status of the export.
Property 'totallines' : int
The total number of lines that are in the exported file.
Property 'availablelines' : int
The number of lines that are now available.
Property 'size' : int
The size in bytes of the export.
Property 'humansize' : string
The size in a human readable format.
Property 'target' : string
The target type of the export.
Property 'filename' : string
The export filename.
Property 'compressed' : boolean
Is the export compressed.
Property 'dateformat' : string
What dateformat should the export use.
Property 'filter' : string
Filter for exporting only specific profiles.
Property 'usequotes' : boolean
Use quotes around the values.
Property 'nextstarttime' : timestamp
The next time when this scheduled event will run.
Property 'schedulediterations' : int
The number of iterations that are still remaining.
Property 'processediterations' : int
The number of iterations that were already processed.
Property 'previousstarttime' : string
The starttime of the last iteration.
Property 'processmissediterations' : boolean
Will the missed iterations be processed anyway?.
Property 'id' : int
The ID of the scheduledevent.