Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Import

Operations for imports

Start Customer-Specific Info import

post

Required Roles: ApiImport

Authorizations
AuthorizationstringRequired
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
channelstringRequired

The channel for which the import was performed.

durationInSecondsinteger · int64Required

The duration of the import process (seconds).

errorMessagesstring[]Required

Import error messages.

importTypestring · enumRequired

The type of data imported.

Possible values:
importedFieldsinteger · int32Required

The number of fields imported.

importedRecordsinteger · int32Optional

The number of records imported.

importedWorldmatchDocumentsinteger · int32Optional

The number of records imported into worldmatch.

startDatestring · date-timeRequired

The time and date that the import was started.

statusMessagesstring[]Required

Import status messages.

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

[
  {
    "channel": "text",
    "durationInSeconds": 1,
    "errorMessages": [
      "text"
    ],
    "importType": "DATA",
    "importedFields": 1,
    "importedRecords": 1,
    "importedWorldmatchDocuments": 1,
    "startDate": "2026-01-01T00:00:00.000Z",
    "statusMessages": [
      "text"
    ]
  }
]

Start embedding import

post

Required Roles: ApiImport

Authorizations
AuthorizationstringRequired
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
channelstringRequired

The channel for which the import was performed.

durationInSecondsinteger · int64Required

The duration of the import process (seconds).

errorMessagesstring[]Required

Import error messages.

importTypestring · enumRequired

The type of data imported.

Possible values:
importedFieldsinteger · int32Required

The number of fields imported.

importedRecordsinteger · int32Optional

The number of records imported.

importedWorldmatchDocumentsinteger · int32Optional

The number of records imported into worldmatch.

startDatestring · date-timeRequired

The time and date that the import was started.

statusMessagesstring[]Required

Import status messages.

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

[
  {
    "channel": "text",
    "durationInSeconds": 1,
    "errorMessages": [
      "text"
    ],
    "importType": "DATA",
    "importedFields": 1,
    "importedRecords": 1,
    "importedWorldmatchDocuments": 1,
    "startDate": "2026-01-01T00:00:00.000Z",
    "statusMessages": [
      "text"
    ]
  }
]

Start geo import

post

Required Roles: ApiImport

Authorizations
AuthorizationstringRequired
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
channelstringRequired

The channel for which the import was performed.

durationInSecondsinteger · int64Required

The duration of the import process (seconds).

errorMessagesstring[]Required

Import error messages.

importTypestring · enumRequired

The type of data imported.

Possible values:
importedFieldsinteger · int32Required

The number of fields imported.

importedRecordsinteger · int32Optional

The number of records imported.

importedWorldmatchDocumentsinteger · int32Optional

The number of records imported into worldmatch.

startDatestring · date-timeRequired

The time and date that the import was started.

statusMessagesstring[]Required

Import status messages.

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

[
  {
    "channel": "text",
    "durationInSeconds": 1,
    "errorMessages": [
      "text"
    ],
    "importType": "DATA",
    "importedFields": 1,
    "importedRecords": 1,
    "importedWorldmatchDocuments": 1,
    "startDate": "2026-01-01T00:00:00.000Z",
    "statusMessages": [
      "text"
    ]
  }
]

Start ranking import

post

Required Roles: ApiImport

Authorizations
AuthorizationstringRequired
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
channelstringRequired

The channel for which the import was performed.

durationInSecondsinteger · int64Required

The duration of the import process (seconds).

errorMessagesstring[]Required

Import error messages.

importTypestring · enumRequired

The type of data imported.

Possible values:
importedFieldsinteger · int32Required

The number of fields imported.

importedRecordsinteger · int32Optional

The number of records imported.

importedWorldmatchDocumentsinteger · int32Optional

The number of records imported into worldmatch.

startDatestring · date-timeRequired

The time and date that the import was started.

statusMessagesstring[]Required

Import status messages.

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

[
  {
    "channel": "text",
    "durationInSeconds": 1,
    "errorMessages": [
      "text"
    ],
    "importType": "DATA",
    "importedFields": 1,
    "importedRecords": 1,
    "importedWorldmatchDocuments": 1,
    "startDate": "2026-01-01T00:00:00.000Z",
    "statusMessages": [
      "text"
    ]
  }
]

Start recommendation import

post

Required Roles: ApiImport

Authorizations
AuthorizationstringRequired
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
channelstringRequired

The channel for which the import was performed.

durationInSecondsinteger · int64Required

The duration of the import process (seconds).

errorMessagesstring[]Required

Import error messages.

importTypestring · enumRequired

The type of data imported.

Possible values:
importedFieldsinteger · int32Required

The number of fields imported.

importedRecordsinteger · int32Optional

The number of records imported.

importedWorldmatchDocumentsinteger · int32Optional

The number of records imported into worldmatch.

startDatestring · date-timeRequired

The time and date that the import was started.

statusMessagesstring[]Required

Import status messages.

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

[
  {
    "channel": "text",
    "durationInSeconds": 1,
    "errorMessages": [
      "text"
    ],
    "importType": "DATA",
    "importedFields": 1,
    "importedRecords": 1,
    "importedWorldmatchDocuments": 1,
    "startDate": "2026-01-01T00:00:00.000Z",
    "statusMessages": [
      "text"
    ]
  }
]

Refresh recommendation databases

post

Required Roles: ApiImport

Authorizations
AuthorizationstringRequired
Query parameters
channelstring[]Optional
Responses
200

OK

No content
post/rest/v5/import/refreshRecommendations
POST /fact-finder/rest/v5/import/refreshRecommendations HTTP/1.1
Host: vector-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
AuthorizationstringRequired
Query parameters
channelstring[]Required
Responses
200

OK

application/json
booleanOptional
get/rest/v5/import/running
GET /fact-finder/rest/v5/import/running?channel=text HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

true

Start search import

post

Required Roles: ApiImport

Authorizations
AuthorizationstringRequired
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
channelstringRequired

The channel for which the import was performed.

durationInSecondsinteger · int64Required

The duration of the import process (seconds).

errorMessagesstring[]Required

Import error messages.

importTypestring · enumRequired

The type of data imported.

Possible values:
importedFieldsinteger · int32Required

The number of fields imported.

importedRecordsinteger · int32Optional

The number of records imported.

importedWorldmatchDocumentsinteger · int32Optional

The number of records imported into worldmatch.

startDatestring · date-timeRequired

The time and date that the import was started.

statusMessagesstring[]Required

Import status messages.

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

[
  {
    "channel": "text",
    "durationInSeconds": 1,
    "errorMessages": [
      "text"
    ],
    "importType": "DATA",
    "importedFields": 1,
    "importedRecords": 1,
    "importedWorldmatchDocuments": 1,
    "startDate": "2026-01-01T00:00:00.000Z",
    "statusMessages": [
      "text"
    ]
  }
]

Start suggest import

post

Required Roles: ApiImport

Authorizations
AuthorizationstringRequired
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
channelstringRequired

The channel for which the import was performed.

durationInSecondsinteger · int64Required

The duration of the import process (seconds).

errorMessagesstring[]Required

Import error messages.

importTypestring · enumRequired

The type of data imported.

Possible values:
importedFieldsinteger · int32Required

The number of fields imported.

importedRecordsinteger · int32Optional

The number of records imported.

importedWorldmatchDocumentsinteger · int32Optional

The number of records imported into worldmatch.

startDatestring · date-timeRequired

The time and date that the import was started.

statusMessagesstring[]Required

Import status messages.

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

[
  {
    "channel": "text",
    "durationInSeconds": 1,
    "errorMessages": [
      "text"
    ],
    "importType": "DATA",
    "importedFields": 1,
    "importedRecords": 1,
    "importedWorldmatchDocuments": 1,
    "startDate": "2026-01-01T00:00:00.000Z",
    "statusMessages": [
      "text"
    ]
  }
]
PreviousCluster
NextJobs

Last updated

Was this helpful?