Content Participations API

Content Participations API je primární integrační vstup pro reporting studia. Vrací studijní záznamy uživatelů, jejich stav a vazby na obsah.

K čemu to použít

Studijní záznamy vznikají v Knowspreadu, ale číst je potřebují i systémy okolo: personalistika, datový sklad, evidence kvalifikací. Tento endpoint je místo, odkud si je odnesou, aniž by někdo přepisoval tabulky.

• Noční synchronizace bere jen to, co se změnilo. HR systém potřebuje vědět, kdo dokončil povinné školení. Integrace si každou noc vyžádá výpis filtrovaný podle updated_at od posledního běhu a přenese jen nové a změněné záznamy. Celou historii nestahuje znovu.
• BI systém dostane stav plnění, ne opsané počty. Vedení chce vidět, kolik lidí školení dokončilo a kolik ne. Integrace filtruje výpis podle stavu a completed_at a plní datový sklad. Nikdo neopisuje čísla z obrazovky.
• Certifikát se uloží do personální složky. Zaměstnanec dokončí školení a personální systém si vyžádá certifikát. Když endpoint vrátí 202 Accepted, integrace dotaz za chvíli zopakuje; jakmile přesměruje na PDF, uloží ho k záznamu. Odpadá ruční stahování a přikládání.

Jakmile potřebujete jeden konkrétní záznam, sáhnete po detailu. Ten vyžaduje vazbu přes uživatele a jeho členství v company space; samotné ID participation nestačí.

Výpis

Výpis podporuje filtrování podle:

• stavu,
• completed_at,
• updated_at,
• stránkování,
• řazení.

Typické použití je inkrementální synchronizace do externího HR nebo BI systému.

Detail

Detail ověřuje, že studijní záznam patří uživateli v daném company space. Nestačí tedy znát ID participation, musí existovat vazba přes uživatele a jeho členství.

Certifikát

Endpoint certifikátu může:

• přesměrovat na hotové PDF,
• vrátit 202 Accepted, pokud se PDF teprve generuje.

Integrátor musí počítat s opakováním dotazu nebo asynchronním zpracováním.