Cluster

Operations for a node inside of a cluster

Fully synchronize the worldmatch database of this node.

post

Required Roles: ApiImport Applies missing delta updates to the worldmatch database if this node is on the same databaseVersion as the director. Otherwise it reloads the worldmatch database from postgres.

Authorizations

basicAuthoAuth2

AuthorizationstringRequired

Responses

200

OK

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

post

/rest/v5/cluster/database/sync/full

HTTPcURLJavaScriptPython

POST /fact-finder/rest/v5/cluster/database/sync/full HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

No content

Reset the config version counters for all(global, channel specific and properties) configs of this node(set it to 0).

post

Required Roles: ApiConfig

Authorizations

basicAuthoAuth2

AuthorizationstringRequired

Responses

200

OK

application/json

stringOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

post

/rest/v5/cluster/reset/config/version/counters

HTTPcURLJavaScriptPython

POST /fact-finder/rest/v5/cluster/reset/config/version/counters HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

text

Prune delta updates.

post

Required Roles: ApiImport Deletes the delta updates table and increments the databaseVersion. After prune every worker has to reload the worldmatch database once to get in sync with the director. In contrast to a full re-import this does not discard any delta updates which are already applied to the intermediate database.

Authorizations

basicAuthoAuth2

AuthorizationstringRequired

Path parameters

channelstringRequired

The channel

Responses

200

OK

application/json

stringOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

post

/rest/v5/cluster/{channel}/database/prune

HTTPcURLJavaScriptPython

POST /fact-finder/rest/v5/cluster/{channel}/database/prune HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

text

Show the current state of the worldmatch database.

get

Required Roles: ApiImport

Authorizations

basicAuthoAuth2

AuthorizationstringRequired

Path parameters

channelstringRequired

The channel

Responses

200

OK

application/json

The worldmatch database state.

databaseVersioninteger · int64Optional

The version of the current worldmatch database. If the databaseVersion of a worker is less than the databaseVersion of the director, the worker needs to reload the whole worldmatch database in order to synchronize itself with the director.

deltaErrorCountinteger · int64Optional

The number of errors (rejected delta updates) which occurred while trying to synchronize worker and director. Reloading the worldmatch database resets this counter to zero.

deltaVersioninteger · int64Optional

The number of delta updates applied to the current worldmatch database. If the deltaVersion of a worker is less than the deltaVersion of the directory, but the databaseVersions are equal, applying the missing delta updates to the worker is sufficient to synchronize worker and director.

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

get

/rest/v5/cluster/{channel}/database/state

HTTPcURLJavaScriptPython

GET /fact-finder/rest/v5/cluster/{channel}/database/state HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

{
  "databaseVersion": 1,
  "deltaErrorCount": 1,
  "deltaVersion": 1
}

Synchronize the worldmatch database of this node.

post

Required Roles: ApiImport Applies missing delta updates to the worldmatch database if this node is on the same databaseVersion as the director. Otherwise a reload of the worldmatch database is necessary to synchronize this node with the director.

Authorizations

basicAuthoAuth2

AuthorizationstringRequired

Path parameters

channelstringRequired

The channel

Query parameters

verbosebooleanOptionalDefault: false

Responses

200

OK

application/json

successbooleanRequired

If true, the operation succeeded. Otherwise an error occurred which will be described in the error field.

Example: true

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

409

Conflict - The worldmatch database is outdated and an import (LOAD_ONLY) is necessary.

application/json

500

Server Error

application/json

post

/rest/v5/cluster/{channel}/database/sync

HTTPcURLJavaScriptPython

POST /fact-finder/rest/v5/cluster/{channel}/database/sync HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

{
  "error": {
    "description": "Unique value already exists: ArticleNumber=1234",
    "name": "FieldConstraintException",
    "stacktrace": "de.factfinder.worldmatch.index.FieldConstraintException: Unique value already exists: ArticleNumber=1234"
  },
  "record": {
    "MasterArticleNumber": "3d407d51e8ca255a429fab65961428cc",
    "ArticleNumber": "123-4567",
    "Title": "Osprey - Women's Tempest 30 - Touring backpack",
    "IsMaster": true,
    "Manufacturer": "Osprey",
    "InsertDate": "2017-03-02T01:00:00+01:00",
    "Image": "http://demoshop.fact-finder.de/demoshop-images/bergfreunde/sol_502-2806-0111_pic1_1.jpg",
    "Price": 100.95,
    "Colors": [
      "red",
      "grey"
    ],
    "RatingCount": 0,
    "Category": [
      [
        "Outdoor equipment",
        "Backpacks",
        "Mountaineering backpacks"
      ],
      [
        "Outdoor equipment",
        "Backpacks",
        "Daypacks"
      ]
    ],
    "VAT": "20",
    "MultiFilter": {
      "Volume": [
        30.5
      ],
      "Recommended use": [
        "Trail running",
        "Trekking",
        "Hillwalking"
      ],
      "Features": [
        "Ice-pick holder",
        "Front access",
        "Mesh back",
        "Hydration compatible"
      ],
      "Weight": [
        860
      ]
    },
    "GtinList": [
      "0-943396-04-1",
      "0-85131-041-1"
    ],
    "BooleanList": [
      true,
      false,
      true,
      true
    ]
  },
  "success": true,
  "warnings": [
    {
      "description": "Unique value already exists: ArticleNumber=1234",
      "name": "FieldConstraintException",
      "stacktrace": "de.factfinder.worldmatch.index.FieldConstraintException: Unique value already exists: ArticleNumber=1234"
    }
  ]
}

Show the import state of this node.

get

Required Roles: ApiImport

Authorizations

basicAuthoAuth2

AuthorizationstringRequired

Path parameters

channelstringRequired

The channel

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

get

/rest/v5/cluster/{channel}/import/state

HTTPcURLJavaScriptPython

GET /fact-finder/rest/v5/cluster/{channel}/import/state HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

{
  "importCounts": [
    {
      "count": 1,
      "type": "DATA"
    }
  ]
}

Get the cluster state. Includes database & import & cache state.

get

Required Roles: ApiImport

Authorizations

basicAuthoAuth2

AuthorizationstringRequired

Path parameters

channelstringRequired

The channel

Responses

200

OK

application/json

cacheFlushinteger · int64Optional

Number of completed cache flushes.

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

get

/rest/v5/cluster/{channel}/state

HTTPcURLJavaScriptPython

GET /fact-finder/rest/v5/cluster/{channel}/state HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

{
  "cacheFlush": 1,
  "database": {
    "databaseVersion": 1,
    "deltaErrorCount": 1,
    "deltaVersion": 1
  },
  "imports": [
    {
      "count": 1,
      "type": "DATA"
    }
  ]
}