Vorig onderwerp

Volgend onderwerp

Inhoud boek

Book Index

Zoeken naar documentgeneratie-runs uitgebreid met statusfilter (4.1.4.5)

Documentgeneratie wordt asynchroon uitgevoerd in runs. Met GET document/api/v1/runs vraag je de productaanvraag-runs op die aan de opgegeven criteria voldoen. Tot nu toe kon je daarbij filteren op de ouderrun (ouderrunid) en het aantal resultaten beperken (limit).

Deze aanroep is uitgebreid met de optionele query-parameter statusrunid. Geef je die mee, dan worden alleen de runs met die status geretourneerd, bijvoorbeeld alleen de runs met de status Mislukt. Laat je de parameter weg, dan verandert er niets aan het resultaat.

URL

Parameter

Type

Toelichting

GET document/api/v1/runs

statusrunid

string (optioneel)

Alleen runs met deze status worden geretourneerd. Zonder deze parameter worden de runs met alle statussen geretourneerd.

Je geeft de naam van de status mee. De mogelijke waarden zijn:

  • NotSet
  • Initieel
  • BezigMetVerzamelenGegevens
  • KlaarMetVerzamelenGegevens
  • BezigMetOpmakenDocumenten
  • KlaarMetOpmakenDocumenten
  • Mislukt
  • BezigMetStartenRun
  • KlaarVoorAfdrukkenVerzenden
  • BezigMetOnderliggendeRuns

Impact voor jou

Je kunt runs nu gericht opvragen op status, bijvoorbeeld om alleen de mislukte runs op te halen. Je hoeft daarvoor niet meer alle runs op te vragen en die zelf te filteren.