The Objects API lets you migrate objects between Fusion instances by exporting and importing. Fusion objects include all your searchable data, plus pipelines, aggregations, and other configurations on which your collections depend.

You can select all objects, or limit the operation to specific object types or IDs. In addition to export/import endpoints, a validation endpoint is provided for troubleshooting.

This service was introduced in Fusion 3.0.

Note

By default, system-created collections are not exported. See below for details.

Exporting linked objects

When exporting a specific Fusion object, you can also export its linked objects without specifying each one individually. To export all objects linked to the specified object, include the deep="true" query parameter in your request. See the example below. When deep is "true", Fusion follows these link types:

DependsOn

HasPart

RelatesTo

Validation

Objects are validated before import. If any objects fail validation, the whole import request is rejected. A separate endpoint is available for validating objects without importing them.

Validation includes checking whether an object already exists on the target system and whether the user is authorized to create or modify the object.

For collection objects, the following special validation is performed:

We check the searchClusterId of each collection and verify that a cluster with this ID exists on the target system or in the import file (error).

We check that features, index profiles, and query profiles belong only to the collections specified in the import file (error).

We check that a feature exists on the target system for each feature in the import file (error).

We check for index profiles or query profiles that do not exist on the target system or in the import file (warning).

For job objects, which contain schedule configurations, Fusion only imports them if their associated task, datasource, or spark objects are also present, either on the target host or in the import file.

Status messages

Validation completed with no errors

The validation method was called and no errors found, though there may be warnings.

Validation found errors

The validation was called and errors found. Validation does not stop on the first error, so the complete list of errors is reported.

Validation was not completed because of system error

The validation was interrupted by system error.

Import was not performed because validation errors exist

The import method was called, but import didn’t start because of validation errors.

Import was not performed because of input data error

The import method was called, but import didn’t start, because Fusion could not find a substitution for one of the secret values in objects in import.

Import was not completed because of system error

The validation found no errors and import started, but it was interrupted by system error.