Import

The method imports or updates the specified entities.

Note: For the import of an application structure, see DeepImport.

Request

Import

Parameters

  • username (String): Name of the user (syntax: system name / client number / user name / department)

    Note: When only one client is installed, the system name is optional.

  • password : Password of the user specified in username

    Type: string

  • mainType (String): Name of the main type of the entities you want to import

    Note: If the format is XML, you can omit this parameter because the main type is provided in the XML for each entity.

  • format (String): Data format, must be XML or CSV

    Note: See also formats in Serialization.

  • failOnError (optional, Boolean): Flag indicating whether the processing of the command shall continue or abort in an error:If ‑failonerror option is set to true, the processing of the command will stop if an error occursIf ‑failonerror option is set to false (default value), the processing will continue even if there is an error

  • data (CSV or XML): The data in XML or CSV which should be imported. If format is XML the XML string has to be passed as CDATA with syntax <![CDATA[xml data]]>

Entities are imported in the order you have specified in your body, one after the other. If the entity does not exist, it is created. If it exists, all provided properties are updated - properties not provided in the input data will remain unchanged.

Response

See section Result object on WebService. See: Import/Export Web Service.