Export

The method exports entities of a specified type

Note: For the export of an application structure, see DeepExport.

Request

Export

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 to export

  Note: Use this option to export a specific main type only. If you leave the parameter empty, all main types are exported.

• customType (optional, String): Name of the custom type of the entities to export

  Note: Use this option to export a specific custom type only. If you leave the parameter empty, all custom types are exported.

• begin (optional, Integer): Index of the entity to begin the export from

  Note: If not set, the export begins with the first entity (index number of the first entity is 0).

• count (optional, Integer): Number of entities to export (0 to 1000)

  Note: If not set, all entities are exported.

• format: Data format, must be XML or CSV

  Note: See also formats in Serialization.

• properties: Array of properties to export

  Notes:

  • Per default all properties are exported. When exporting n-to- m relations, only identity properties of the respective entities are exported.
  • Note: When specifying properties which only exist in some custom types, CDA will return an empty value for those entities which do not hold this property.

• startDate (optional, Date): If set, only entities that have been created on that day or after the specified day are considered in the export - otherwise, all entities are considered in the export

• endDate (optional, Date): If set, only entities that have been created until the specified date are considered in the export - otherwise, all entities are considered in the export

• conditions (optional, List): List of conditions to restrict the export

You can use a string array of conditions to filter the data. The format of a single condition is: [propertyname] [operator] '[value]'.

• propertyname: the name of the system or custom property which should be filtered. You can also filter on properties of related entities via the dot notation.

  Example: system_owner.system_name eq 'Max' will filter all entities of the given main type, that are owned by Max.
  

  For conditions, only properties of directly related entities can be used.

  Example:system_component.system_application.system_name is not valid.

• operator: the operator which should be used for filtering. It can be:

  • eq: equal
  • neq: not equal
  • gt: greater than
  • geq: greater than or equal
  • lt: lower than
  • eq: lower than or equal
  • like: matches a pattern with * as wildcard
  • unlike: matches a pattern with * as wildcard
• 'value': the filter value. It has to be quoted in single quotes. If you filter for something eq '' both empty values and NULL values are found.

Notes:

• If multiple conditions are given, all of them are applied (AND)
• If there are multiple properties with the same name but different types (for example, one is a date and time property, the other a longtext property), the operator behaves as if both properties are a string (for example, greater or lower than will not work as expected for the date and time property)

Example: CSV

The header row of a CSV formatted list of --main-type package may look like the following:

system_id,system_name,description,system_custom_type

Response

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