...

GET {miljø}/dibk/{app}/instances/{instance.id}/data/{data.id}/user-defined-metadata
Headers: {Authorization: bearer [Exchanged ID-porten eller Maskinportentoken]}

Respons: 
{
  "userDefinedMetadata": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

PDF

Det blir produsert en PDF av både hovedskjemaet og eventuelle underskjemaer. Brukerne skal kunne hente en forhåndsvisning av PDF-en før signering, samt en signert versjon når søknaden er sendt inn og signert av brukeren.

Målet er å benytte Altinn3 sin løsning for PDF-generering, men da denne mangler noen nødvendige komponenter, oppfyller den ikke alle våre krav til PDF-produksjon.

Vi har derfor valgt å utvikle en egen PDF-løsning utenfor Altinn3 appen inntil videre, med planer om å migrere til Altinn sin løsning på et senere tidspunkt. Informasjon om hva som gjelder for den aktuelle tjenesten skal stå på egne dokumentasjonssider for tjenesten Altinn 3 Tjenester

Forskjellen på de to løsningene er i hovedsak hvilke endepunkt man bruker for å hente ut forhåndsvisning, og datatype man bruker for å hente den signert versjon

PDF produsert av Altinn3 appen

PDF-generering av hovedskjemaet er en innebygd funksjon i Altnn3-rammeverket, og vi ønsker å benytte denne funksjonaliteten. Om det er i bruk på den aktuelle tjenesten ser man dersom en datatype er konfigurert med "enablePdfCreation": true. Appen skal og være konfigurert med en datatype med id
ref-data-as-pdf.

Utvid
title Eksempel: enablePdfCreation: true
Image Removed

Utvid
title Eksempel ref-data-as-pdf
Image Removed

Forhåndsvisning

GET {miljø}/dibk/{app}/instances/{instance.id}/pdf/preview
Headers: {
          Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]
         }

Signert PDF

Den signerte PDF-en blir tilgjengelig som et dataelement på instansen, på datatypen ref-data-as-pdf

Den signerte PDF-en blir produsert etter at det er gjort en Altinn-signatur og appen har gått videre til prosessens slutt (process end). Den signerte PDF-en vil deretter være tilgjengelig på den aktuelle datatypen, og man kan gjøre en GET-forespørsel på dataelementet for å hente den.

GET {miljø}/dibk/{app}/instances/{instance.id}/data/{data.id} // Signert pdf
Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]}

PDF produsert utenfor Altinn3 appen

Hver app konfigureres med hvilke datatyper det produseres PDF av, men denne informasjonen er ikke tilgjengelig i appens metadata da dette ikke er en del av Altinn-løsningen. Informasjonen skal i stedet være tilgjengelig på egne dokumentasjonssider for den aktuelle tjenesten.

Forhåndsvisning

Man kan få en forhåndsvisning av PDF-en ved å kalle pdfpreview på enten instansen eller på det aktuelle dataelementet.

Forhåndsvisning på instansen:

Ved å kalle pdfpreview på instansen, vil du få en PDF-forhåndsvisning med data på den datatypen som er konfigurert som hovedskjemaet for appen.

Det blir produsert en PDF av både hovedskjemaet og eventuelle underskjemaer. Brukerne skal kunne hente en forhåndsvisning av PDF-en før signering, samt en signert versjon når søknaden er sendt inn og signert av brukeren.

Forhåndsvisning

Det er forskjell om man henter ut forhåndsvisning av et hovedskjema eller underskjema.

Hovedskjema

GET {miljø}/dibk/{app}/instances/{instance.id}/pdfpreviewpdf/preview
Headers: {
          Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]
         }

...

Underskjema

Gjelder for datatyper som er definert som underskjema

Ved å kalle pdfpreview på et dataelement, vil du få en PDF-forhåndsvisning med data på det aktuelle dataelementet, dersom datatypen er konfigurert for PDF-generering.

GET {miljø}/dibk/{app}/instances/{instance.id}/data/{data.id}/pdfpreview
Headers: {
          Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]
         }

...

Signert PDF

Den signerte PDF-en blir tilgjengelig som et dataelement på instansen. Datatypen som brukes vil kan være konfigurert forskjellig i de ulike appene, så informasjon om dette vil være tilgjengelig på egne dokumentasjonssider for den aktuelle tjenesten.

Den signerte PDF-en blir produsert etter at det er gjort en Altinn-signatur og appen har gått videre til prosessens slutt (process end). Den signerte PDF-en vil deretter være tilgjengelig på den aktuelle datatypen, og man kan gjøre en GET-forespørsel på dataelementet for å hente den.

...