Overzicht
Service, of Product, om documenten inclusief hun metadata op een veilige manier op te slaan en te archiveren
Generieke IT-bouwblokken
SubdomeinAs a Service
TypologieService & API
Service ownerRSZ
2018
Hergebruik12
Integration effortFunctionele beschrijving
De API REST/documentRepository beheert de opslag van documenten en de eraan gelinkte metadata, de eventuele archivering, alsook de toegang tot deze documenten, en biedt volgende functionaliteiten:
- Uploaden van een nieuw document. De inhoud en metadata van het document worden opgeslagen in Document Repository en wanneer gereed voor archivering, wordt een archiveringsverzoek ingediend bij Archiving-as-a-Service (AAAS), de elektronische archiveringservice met bewijskracht beschikbaar op de G-Cloud
- Verzoeken om een document dat eerder in Document Repository was geüpload en op dat moment niet hoefde te worden gearchiveerd alsnog te archiveren
- Uploaden van een externe locatie. Hierdoor kan de clienttoepassing de locatie van een document dat zich in een externe map of opslagruimte buiten Document Repository bevindt, toevoegen aan Document Repository alsook er de metadata opslaan (om Document Repository als centrale indexerings- en zoekmachine te gebruiken)
- Consulteren van de inhoud van een document dat eerder naar Document Repository werd geüpload of zich in een externe map bevindt
- Consulteren van de inhoud en metadata van een document dat eerder naar Document Repository werd geüpload of zich in een externe map bevindt
- Consulteren van de metadata van een document dat eerder naar Document Repository werd geüpload
- Updaten van de metadata van een document. Hierdoor kunnen metadata die bij het document horen, volledig vervangen worden
- Verkrijgen van een lijst van documenten en hun metadata op basis van zoekcriteria
- Verwijderen van de inhoud van een document en alle informatie die ermee verbonden is
Opmerkingen:
- Een opslag- of archiveringsverzoek kan voor slechts één document tegelijk gedaan worden
- Het archiveringsproces is asynchroon; documenten worden niet onmiddellijk gearchiveerd
- Documenten en hun metadata kunnen onmiddellijk na het uploaden geraadpleegd worden in Document Repository
Doelpubliek
Elke toepassing die een document en bijhorende metadata dient op te slaan en te archiveren.
Integratievoorwaarden
Om de API REST/documentRepository te integreren dient men:
- De administratieve procedures te hebben doorlopen, nl. integreren met de identificatie- en authenticatieservice van de sociale zekerheid
- Om documenten in AAAS te archiveren dient aan de nodige integratievoorwaarden voldaan te zijn (zie voorwaarden van de AAAS-service)
Documentatie
Contact
Contact: ReuseOperational@smals.be