Import

Operations for imports

Start Customer-Specific Info import

post

Required Roles: ApiImport

Authorizations
Query parameters
cacheFlushbooleanOptional

if true: causes a cache flush after a channel has been imported

Default: false
channelstring[]Optional
downloadbooleanOptional

if true: causes the import file to be updated first. If no URL is stored in the FACT-Finder configuration, this parameter has no effect.

Default: false
importStagestring · enumOptional

IMPORT_ONLY only fills the intermediate DB, LOAD_ONLY imports that database into memory, and FULL combines both stages

Default: FULLPossible values:
quietbooleanOptional

if true: only receive a filled response if an error occurs during the import otherwise the response is just empty

Default: false
Responses
200

OK

application/json
post
POST /fact-finder//rest/v5/import/customerprices HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Accept: */*

[
  {
    "channel": "text",
    "durationInSeconds": 1,
    "errorMessages": [
      "text"
    ],
    "importType": "DATA",
    "importedFields": 1,
    "importedRecords": 1,
    "importedWorldmatchDocuments": 1,
    "startDate": "2025-08-15T14:07:03.625Z",
    "statusMessages": [
      "text"
    ]
  }
]

Start embedding import

post

Required Roles: ApiImport

Authorizations
Query parameters
channelstring[]Optional
quietbooleanOptional

if true: only receive a filled response if an error occurs during the import otherwise the response is just empty

Default: false
Responses
200

OK

application/json
post
POST /fact-finder//rest/v5/import/embedding HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Accept: */*

[
  {
    "channel": "text",
    "durationInSeconds": 1,
    "errorMessages": [
      "text"
    ],
    "importType": "DATA",
    "importedFields": 1,
    "importedRecords": 1,
    "importedWorldmatchDocuments": 1,
    "startDate": "2025-08-15T14:07:03.625Z",
    "statusMessages": [
      "text"
    ]
  }
]

Start geo import

post

Required Roles: ApiImport

Authorizations
Query parameters
cacheFlushbooleanOptional

if true: causes a cache flush after a channel has been imported

Default: false
channelstring[]Optional
downloadbooleanOptional

if true: causes the import file to be updated first. If no URL is stored in the FACT-Finder configuration, this parameter has no effect.

Default: false
importStagestring · enumOptional

IMPORT_ONLY only fills the intermediate DB, LOAD_ONLY imports that database into memory, and FULL combines both stages

Default: FULLPossible values:
quietbooleanOptional

if true: only receive a filled response if an error occurs during the import otherwise the response is just empty

Default: false
Responses
200

OK

application/json
post
POST /fact-finder//rest/v5/import/geo HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Accept: */*

[
  {
    "channel": "text",
    "durationInSeconds": 1,
    "errorMessages": [
      "text"
    ],
    "importType": "DATA",
    "importedFields": 1,
    "importedRecords": 1,
    "importedWorldmatchDocuments": 1,
    "startDate": "2025-08-15T14:07:03.625Z",
    "statusMessages": [
      "text"
    ]
  }
]

Start ranking import

post

Required Roles: ApiImport

Authorizations
Query parameters
cacheFlushbooleanOptional

if true: causes a cache flush after a channel has been imported

Default: false
channelstring[]Optional
quietbooleanOptional

if true: only receive a filled response if an error occurs during the import otherwise the response is just empty

Default: false
Responses
200

OK

application/json
post
POST /fact-finder//rest/v5/import/ranking HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Accept: */*

[
  {
    "channel": "text",
    "durationInSeconds": 1,
    "errorMessages": [
      "text"
    ],
    "importType": "DATA",
    "importedFields": 1,
    "importedRecords": 1,
    "importedWorldmatchDocuments": 1,
    "startDate": "2025-08-15T14:07:03.625Z",
    "statusMessages": [
      "text"
    ]
  }
]

Start recommendation import

post

Required Roles: ApiImport

Authorizations
Query parameters
channelstring[]Optional
quietbooleanOptional

if true: only receive a filled response if an error occurs during the import otherwise the response is just empty

Default: false
Responses
200

OK

application/json
post
POST /fact-finder//rest/v5/import/recommendation HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Accept: */*

[
  {
    "channel": "text",
    "durationInSeconds": 1,
    "errorMessages": [
      "text"
    ],
    "importType": "DATA",
    "importedFields": 1,
    "importedRecords": 1,
    "importedWorldmatchDocuments": 1,
    "startDate": "2025-08-15T14:07:03.625Z",
    "statusMessages": [
      "text"
    ]
  }
]

Refresh recommendation databases

post

Required Roles: ApiImport

Authorizations
Query parameters
channelstring[]Optional
Responses
200

OK

post
POST /fact-finder//rest/v5/import/refreshRecommendations HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Accept: */*

No content

Check if an import is running in any of the supplied channels

get

Required Roles: ApiImport

Authorizations
Query parameters
channelstring[]Required
Responses
200

OK

application/json
Responseboolean
get
GET /fact-finder//rest/v5/import/running HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Accept: */*

true

Start search import

post

Required Roles: ApiImport

Authorizations
Query parameters
cacheFlushbooleanOptional

if true: causes a cache flush after a channel has been imported

Default: false
channelstring[]Optional
downloadbooleanOptional

if true: causes the import file to be updated first. If no URL is stored in the FACT-Finder configuration, this parameter has no effect.

Default: false
importStagestring · enumOptional

IMPORT_ONLY only fills the intermediate DB, LOAD_ONLY imports that database into memory, and FULL combines both stages

Default: FULLPossible values:
includeCustomerPricesbooleanOptional

if true: executes a Customer-Specific Info import after the search import. If Customer-Specific Info is not enabled for a given channel, this parameter has no effect.

Default: false
includeGeobooleanOptional

if true: executes a geo import after the search import. If the geo module is not enabled for a given channel, this parameter has no effect.

Default: false
quietbooleanOptional

if true: only receive a filled response if an error occurs during the import otherwise the response is just empty

Default: false
Responses
200

OK

application/json
post
POST /fact-finder//rest/v5/import/search HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Accept: */*

[
  {
    "channel": "text",
    "durationInSeconds": 1,
    "errorMessages": [
      "text"
    ],
    "importType": "DATA",
    "importedFields": 1,
    "importedRecords": 1,
    "importedWorldmatchDocuments": 1,
    "startDate": "2025-08-15T14:07:03.625Z",
    "statusMessages": [
      "text"
    ]
  }
]

Start suggest import

post

Required Roles: ApiImport

Authorizations
Query parameters
channelstring[]Optional
quietbooleanOptional

if true: only receive a filled response if an error occurs during the import otherwise the response is just empty

Default: false
Responses
200

OK

application/json
post
POST /fact-finder//rest/v5/import/suggest HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Accept: */*

[
  {
    "channel": "text",
    "durationInSeconds": 1,
    "errorMessages": [
      "text"
    ],
    "importType": "DATA",
    "importedFields": 1,
    "importedRecords": 1,
    "importedWorldmatchDocuments": 1,
    "startDate": "2025-08-15T14:07:03.625Z",
    "statusMessages": [
      "text"
    ]
  }
]
PreviousClusterNextJobs

Was this helpful?