Import objects

import requests

url = "https://{FUSION HOST}/api/objects/import"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contentDisposition\"\r\n\r\n{\n  \"type\": \"<string>\",\n  \"parameters\": {},\n  \"fileName\": \"<string>\",\n  \"creationDate\": \"2023-11-07T05:31:56Z\",\n  \"modificationDate\": \"2023-11-07T05:31:56Z\",\n  \"readDate\": \"2023-11-07T05:31:56Z\",\n  \"size\": 123\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"entity\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"headers\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mediaType\"\r\n\r\n{\n  \"type\": \"<string>\",\n  \"subtype\": \"<string>\",\n  \"parameters\": {},\n  \"wildcardType\": true,\n  \"wildcardSubtype\": true\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"messageBodyWorkers\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent\"\r\n\r\n{\n  \"contentDisposition\": {\n    \"type\": \"<string>\",\n    \"parameters\": {},\n    \"fileName\": \"<string>\",\n    \"creationDate\": \"2023-11-07T05:31:56Z\",\n    \"modificationDate\": \"2023-11-07T05:31:56Z\",\n    \"readDate\": \"2023-11-07T05:31:56Z\",\n    \"size\": 123\n  },\n  \"entity\": {},\n  \"headers\": {},\n  \"mediaType\": {\n    \"type\": \"<string>\",\n    \"subtype\": \"<string>\",\n    \"parameters\": {},\n    \"wildcardType\": true,\n    \"wildcardSubtype\": true\n  },\n  \"messageBodyWorkers\": {},\n  \"parent\": {},\n  \"providers\": {},\n  \"bodyParts\": [\n    {\n      \"contentDisposition\": {\n        \"type\": \"<any>\",\n        \"parameters\": \"<any>\",\n        \"fileName\": \"<any>\",\n        \"creationDate\": \"<any>\",\n        \"modificationDate\": \"<any>\",\n        \"readDate\": \"<any>\",\n        \"size\": \"<any>\"\n      },\n      \"entity\": {},\n      \"headers\": {},\n      \"mediaType\": {\n        \"type\": \"<any>\",\n        \"subtype\": \"<any>\",\n        \"parameters\": \"<any>\",\n        \"wildcardType\": \"<any>\",\n        \"wildcardSubtype\": \"<any>\"\n      },\n      \"messageBodyWorkers\": {},\n      \"parent\": {},\n      \"providers\": {},\n      \"parameterizedHeaders\": {}\n    }\n  ],\n  \"parameterizedHeaders\": {}\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providers\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bodyParts\"\r\n\r\n{\n  \"contentDisposition\": {\n    \"type\": \"<any>\",\n    \"parameters\": \"<any>\",\n    \"fileName\": \"<any>\",\n    \"creationDate\": \"<any>\",\n    \"modificationDate\": \"<any>\",\n    \"readDate\": \"<any>\",\n    \"size\": \"<any>\"\n  },\n  \"entity\": {},\n  \"headers\": {},\n  \"mediaType\": {\n    \"type\": \"<any>\",\n    \"subtype\": \"<any>\",\n    \"parameters\": \"<any>\",\n    \"wildcardType\": \"<any>\",\n    \"wildcardSubtype\": \"<any>\"\n  },\n  \"messageBodyWorkers\": {},\n  \"parent\": {},\n  \"providers\": {},\n  \"parameterizedHeaders\": {}\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parameterizedHeaders\"\r\n\r\n{}\r\n-----011000010111000001101001--\r\n"
headers = {"Content-Type": "multipart/form-data; boundary=---011000010111000001101001"}

response = requests.post(url, data=payload, headers=headers)

print(response.json())

{
  "conflicts": [
    "<string>"
  ],
  "variablesWarnings": [
    "<string>"
  ],
  "variablesErrors": [
    "<string>"
  ],
  "variablesSubstitutions": [
    "<string>"
  ],
  "validationWarnings": [
    "<string>"
  ],
  "validationErrors": [
    "<string>"
  ],
  "importErrors": [
    "<string>"
  ],
  "importActions": [
    "<string>"
  ],
  "zipFileToken": "<string>",
  "transformationMsgs": [
    "<string>"
  ],
  "status": "<string>"
}

Import objects

Import one or more objects. Validation is performed before import. Import starts only if validation succeeds. However, validation does not stop on the first error, so the complete list of errors is reported if there are any. You can also use the /objects/validate endpoint to validate an object without importing it.

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).

You can also substitute the password variables in your imported file using a separate file containing plaintext passwords, like this: -F 'variableValues=@password_file.json'

POST

objects

import

Import objects

import requests

url = "https://{FUSION HOST}/api/objects/import"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contentDisposition\"\r\n\r\n{\n  \"type\": \"<string>\",\n  \"parameters\": {},\n  \"fileName\": \"<string>\",\n  \"creationDate\": \"2023-11-07T05:31:56Z\",\n  \"modificationDate\": \"2023-11-07T05:31:56Z\",\n  \"readDate\": \"2023-11-07T05:31:56Z\",\n  \"size\": 123\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"entity\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"headers\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mediaType\"\r\n\r\n{\n  \"type\": \"<string>\",\n  \"subtype\": \"<string>\",\n  \"parameters\": {},\n  \"wildcardType\": true,\n  \"wildcardSubtype\": true\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"messageBodyWorkers\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent\"\r\n\r\n{\n  \"contentDisposition\": {\n    \"type\": \"<string>\",\n    \"parameters\": {},\n    \"fileName\": \"<string>\",\n    \"creationDate\": \"2023-11-07T05:31:56Z\",\n    \"modificationDate\": \"2023-11-07T05:31:56Z\",\n    \"readDate\": \"2023-11-07T05:31:56Z\",\n    \"size\": 123\n  },\n  \"entity\": {},\n  \"headers\": {},\n  \"mediaType\": {\n    \"type\": \"<string>\",\n    \"subtype\": \"<string>\",\n    \"parameters\": {},\n    \"wildcardType\": true,\n    \"wildcardSubtype\": true\n  },\n  \"messageBodyWorkers\": {},\n  \"parent\": {},\n  \"providers\": {},\n  \"bodyParts\": [\n    {\n      \"contentDisposition\": {\n        \"type\": \"<any>\",\n        \"parameters\": \"<any>\",\n        \"fileName\": \"<any>\",\n        \"creationDate\": \"<any>\",\n        \"modificationDate\": \"<any>\",\n        \"readDate\": \"<any>\",\n        \"size\": \"<any>\"\n      },\n      \"entity\": {},\n      \"headers\": {},\n      \"mediaType\": {\n        \"type\": \"<any>\",\n        \"subtype\": \"<any>\",\n        \"parameters\": \"<any>\",\n        \"wildcardType\": \"<any>\",\n        \"wildcardSubtype\": \"<any>\"\n      },\n      \"messageBodyWorkers\": {},\n      \"parent\": {},\n      \"providers\": {},\n      \"parameterizedHeaders\": {}\n    }\n  ],\n  \"parameterizedHeaders\": {}\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providers\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bodyParts\"\r\n\r\n{\n  \"contentDisposition\": {\n    \"type\": \"<any>\",\n    \"parameters\": \"<any>\",\n    \"fileName\": \"<any>\",\n    \"creationDate\": \"<any>\",\n    \"modificationDate\": \"<any>\",\n    \"readDate\": \"<any>\",\n    \"size\": \"<any>\"\n  },\n  \"entity\": {},\n  \"headers\": {},\n  \"mediaType\": {\n    \"type\": \"<any>\",\n    \"subtype\": \"<any>\",\n    \"parameters\": \"<any>\",\n    \"wildcardType\": \"<any>\",\n    \"wildcardSubtype\": \"<any>\"\n  },\n  \"messageBodyWorkers\": {},\n  \"parent\": {},\n  \"providers\": {},\n  \"parameterizedHeaders\": {}\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fields\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parameterizedHeaders\"\r\n\r\n{}\r\n-----011000010111000001101001--\r\n"
headers = {"Content-Type": "multipart/form-data; boundary=---011000010111000001101001"}

response = requests.post(url, data=payload, headers=headers)

print(response.json())

{
  "conflicts": [
    "<string>"
  ],
  "variablesWarnings": [
    "<string>"
  ],
  "variablesErrors": [
    "<string>"
  ],
  "variablesSubstitutions": [
    "<string>"
  ],
  "validationWarnings": [
    "<string>"
  ],
  "validationErrors": [
    "<string>"
  ],
  "importErrors": [
    "<string>"
  ],
  "importActions": [
    "<string>"
  ],
  "zipFileToken": "<string>",
  "transformationMsgs": [
    "<string>"
  ],
  "status": "<string>"
}

Query Parameters

importPolicy

enum<string>

One of the following values:

abort: If there are conflicts, then import nothing.
merge: If there are conflicts, then skip the conflicting objects.
overwrite: If there are conflicts, then overwrite or delete/create the conflicting objects on the target system.

Available options:

abort,

merge,

overwrite

context

string

The name of the Fusion app into which the objects will be imported.

Body

multipart/form-data

The objects to import.

contentDisposition

object

Show child attributes

entity

object

headers

object

Show child attributes

mediaType

object

Show child attributes

messageBodyWorkers

object

parent

object

Show child attributes

providers

object

bodyParts

object[]

Show child attributes

fields

object

Show child attributes

parameterizedHeaders

object

Show child attributes

Response

200 - application/json

successful operation

conflicts

string[]

variablesWarnings

string[]

variablesErrors

string[]

variablesSubstitutions

string[]

validationWarnings

string[]

validationErrors

string[]

importErrors

string[]

importActions

string[]

zipFileToken

string

transformationMsgs

string[]

status

string

Export objects List imported variables

⌘I

Admin

Apps Manager

Async Parsing

Connectors

Indexing

Job Config

Job Launcher

Job Rest Server

ML Model Service

Proxy

Query

Templating

Import objects

Query Parameters

Body

Response