Portfolios

Resumierbaren Portfolio-Sync beginnen

Reserviert genau einen Staging-Lauf fuer die kontoeigene Quelle, ohne das sichtbare Portfolio zu veraendern. base_version muss der letzten Commit-Quittung entsprechen; eine neue Quelle beginnt bei 0 und am aktuellen verifizierten Ereignis-High-Water. Dadurch entstehen weder historische Alarme noch eine Ereignisluecke waehrend des Syncs. relationship_default ordnet den ganzen Quellenbestand als Kunden, Lieferanten, Mandate, Leads oder Partner ein; eine spaetere lokale Firmenwatch-Annotation hat Vorrang. expected_items zaehlt die eindeutigen external_id-Werte des gesamten Laufs, nicht wiederholte Zeilen oder HTTP-Versuche. Dieselbe sync_id mit denselben validierten Startparametern ist ein idempotenter Resume-Abruf und liefert replayed=true. Dieselbe ID mit anderen Parametern oder ein anderer gleichzeitig aktiver Lauf ergibt 409. Ein Staging-Lauf mit seit mehr als 24 Stunden ausbleibender Stapelaktivitaet wird beim naechsten Start verworfen; danach ist eine neue sync_id zu verwenden. Start-Ruempfe sind auf 32 KiB begrenztes, unkomprimiertes UTF-8-JSON. Nach jedem HTTP-5xx ist dieselbe Anfrage sicher wiederholbar.

post/portfolios/{sourceKey}/syncs

Request

  • Base URL: https://firmenwatch.ch/api/v1
  • URL: https://firmenwatch.ch/api/v1/portfolios/{sourceKey}/syncs
  • Auth: HTTP bearer

Path parameters

sourceKeystring required

Dauerhafter, kontoeigener Quellenschluessel. Kleingeschrieben und URL-stabil; dieselbe Quelle muss bei jedem Lauf denselben Wert verwenden.

Request body

sync_idstring required

Vom Client vergebene Idempotenz- und Resume-Kennung. Mit veraenderten Parametern nicht wiederverwenden.

mode'replace' | 'delta' required

replace ist ein vollstaendiger Snapshot; delta enthaelt ausschliesslich explizite Aenderungen.

base_versioninteger required

version der letzten Commit-Quittung; 0 fuer eine noch nicht angelegte Quelle.

expected_itemsinteger required

Exakte Zahl eindeutiger external_id-Werte des gesamten Laufs. Wiederholungen zaehlen nicht erneut.

source_revisionstring nullable

Optionale druckbare Revision des Quellsystems ohne Rand-Leerzeichen.

relationship_default'customer' | 'supplier' | 'mandate' | 'lead' | 'partner' | 'null' nullable required

Schlanke Einordnung fuer alle Firmen dieser Quelle. Eine lokale Firmenwatch-Annotation hat immer Vorrang; null bedeutet keine Quellvorgabe.

Response

Neu angelegter oder idempotent wieder aufgenommener Sync.

Changes

No recorded changes to this operation across all 1 revision of this API.