Import export SOAP web service


In the cloud, importing and exporting files with an import/export template on a local workstation is possible, but you need to manually drag and drop files.

You can completely automate these operations with an API for external tools:

Because an extraction or integration can take time, the API must also be able to handle batch operations.

Web services available

Standard SOAP web services are supplied to manage these operations. These web services use the standard SOAP web service connection pools and can be called from any program able to:

The SOAP web services used are subprograms associated with web services. Their names are the following:

Service name Subprogram Description
AOWSEXPORT AOWSEXPORT.EXPORT Export data associated with a template and parameters
AOWSIMPORT AOWSIMPORT.IMPORT Import data based on an import template
AOWSBATGET AOWSGETBATCH.GET Get information about a batch import/export request

These SOAP web services can be called from any program able to perform a SOAP web service in the correct format as described in web service management. You can, for example, write in Java, PHP, JavaScript, .NET, C…

Export web service

The export web service contains the following arguments:

Group Level Code Description Parameter type Dim Argument type
GRP1 1 I_MODEXP Template Char 1 Sent
GRP1 1 I_CHRONO Sequence no. Char 1 Sent
GRP2 1 I_TCRITERE Criteria Char 10 Sent
GRP3 1 I_EXEC Execution type Char 1 Sent
GRP3 1 I_RECORDSEP Record separator Char 1 Sent
GRP3 1 O_FILE Data file Clbfile 1 Returned
GRP3 1 O_REQNUM Query Integer 1 Returned
GRP3 1 O_STATUS Status Integer 1 Returned
GRP3 1 O_MESSA Message Char 1 Returned

The parameters sent are:

The SOAP parameters returned are:

The values returned are:

Import web service

The import web service contains the following arguments:

Group Level Code Description Parameter type Argument type
GRP1 1 I_MODIMP Template Char Sent
GRP1 1 I_AOWSTA Import/export temporary storage Char Sent
GRP1 1 I_EXEC Execution type Char Sent
GRP1 1 I_RECORDSEP Record separator Char Sent
GRP1 1 I_FILE File Clbfile Sent
GRP1 1 O_REQNUM Query Integer Returned
GRP1 1 O_STATUS Status Integer Returned
GRP1 1 O_MESSA Message Char Returned

The parameters sent are:

For example, if you import 2 lines with a string, a date, and a numeric value, and if the record separator is |, the correct clob contents would be:
STRING1;20170203;1| STRING2;20160512;33|END

The SOAP parameters returned are:

The values returned are:

Get information about import/export batch task

This web service contains the following arguments:

Group Level Code Description Parameter type Argument type
GRP1 1 I_TACHE Batch task Char Sent
GRP1 1 I_REQNUM Query Integer Sent
GRP1 1 I_GETTRA Log Char Sent
GRP1 1 O_STAREQ Status Integer Returned
GRP1 1 O_MESREQ Message Char Returned
GRP1 1 O_FILE File Clbfile Returned
GRP1 1 O_FILETRA File Clbfile Returned
GRP1 1 O_STATUS Status Integer Returned
GRP1 1 O_MESSA Message Char Returned

The parameters sent are:

The SOAP parameters returned are:

The values returned are:

See also :