Export

The method exports entities of a specified type

For the export of an application structure, see Deep Export.

Request

Export

Parameters

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

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

• password (String): Password of the user specified in username

• mainType (String): Name of the main type of the entities to export

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

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

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

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

  If not set, the export will begin with the first entity (index number of the first entity is 0).

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

  If not set, all entities are exported.

• format: Data format, must be XML or CSV

  Siehe auch: 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 will be exported.
  • Note: When specifying properties which only exist in some custom types, ARA 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; e.g. system_owner.system_name eq 'Max' will filter all entities of the given main type, that are owned by Max.
    Note: in conditions only properties of directly related entities can be used. E.g. "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), leq (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 will be found.

  If multiple conditions are given, all of them are applied (AND).

  Note: If there are multiple properties with the same name but different types (e.g. one is a date and time property, the other a longtext property), the operator will behave as if both properties are a string (e.g. 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_customtype

Response

See section Result object on WebService