Send a file in response to a GET request

[Q&A] Components, Datasets and Plug-ins
1

I want to be able to send a file in a response to a GET request. Our customer facing-frontend needs to fetch claim documents from our Novulo-application to show them to the customer. How would this be possible in data definitions or somewhere else?

2

Hi,

If a file is all you need in the response of a REST Process endpoint or REST Data definition endpoint, its quite simple to do.

Here is an example with rest data definition:

  1. Create a data definition just like you would in general - defining the record type, filters, sorts, parameters, that would lead you to the record where your file exists.
  2. Create a Data definition field. Make sure the Data type is “file (Files)”
    image
    image658Ă—536 10.8 KB

    In the expression, reference the field that usually contains the File in your Novulo record.
  3. Create your REST Data definition endpoint, just like you would normally.
  4. Select “Custom Response”, make sure it is a Yes:
    image
    .

Here is what i get when i execute my GET endpoint:

image
image1830Ă—1276 77.1 KB

So if just a file is all you need, you can follow the steps above.

Greetings,
Miroslav

1 Like
3

It works like a charm. Thank you Miroslav.

1 Like
4

@m.gechev For some reason I’m not able to select File as datatype. We have the highest revision of the component that supplies that field in our application. Do you maybe know why?

image
image934Ă—117 9.38 KB

5

Found it:

image
image650Ă—271 14.6 KB

Only allow primitive types for fields should be checked off in order to be able to select File as a datatype at a field

1 Like
6

@m.gechev I have defined a data definition field to be a file:

image
image608Ă—477 20 KB

Then when I do the GET request I get this:"does_this_work": 339078,. How do I use the id to retrieve the file?

EDIT: Solved. This is not the way to go. I’ve built a different rest data definition which you can feed a guid and that returns a file.

7

Hi Joeri,
To return a file from a Data definition, your REST Data endpoint must have the following configs:

  • Return type : Single object
  • Custom response: Enabled
  • On Data definition level - a data definition field of data type file
1 Like