Services Plugins FAQs

PDF Conjurer - return data from API

Plugins
#1

I have a question about https://docs.zeroqode.com/plugins/pdf-conjurer#cf1c037508d14d28bce4d7fe89956cd4

All three checkboxes are ticked in the screenshot. Is this really necessary?

#2

Hey @ch-schroeder ,
Thank you for contacting us.

Here’s a breakdown of these options:

  1. Optional:
  • What it does: If this checkbox is ticked, it means that the parameter is not required when making the API call. The workflow can still run if this parameter is absent.
  • Is it necessary to check: If you want the parameter to be optional (i.e., the workflow can still proceed without it), you can check this box. If the parameter must always be provided when making the API call, leave it unchecked.
  1. Is a list/array:
  • What it does: This checkbox is for indicating whether the parameter should handle multiple values (a list or an array of files, for example).
  • Is it necessary to check: Only check this box if you expect to send multiple files (or values) for that parameter. If you’re uploading a single file, you don’t need to check this box.
  1. Querystring:
  • What it does: This checkbox specifies that the parameter will be included in the query string of the API request (like appending ?key=value to the URL). It’s typically used for simpler GET requests.
  • Is it necessary to check: You’ll only need this box checked if you specifically want to pass the parameter in the URL’s query string. For POST requests, it’s typically not necessary unless the API you’re working with expects it.

Do you need all three checked?

  • No, it’s not strictly necessary to check all three.
  • Check “Optional” if you want to make the parameter optional (i.e., it’s not required for the workflow to run).
  • Check “Is a list/array” only if you’re dealing with multiple values.
  • Check “Querystring” if your API call expects to send parameters in the URL.

In general, it depends on your specific use case and how you’re designing the API workflow. If you’re just uploading a single file and don’t need the file to be optional or passed as a query string, then you don’t need to check all of them.

Best Regards,
Anton

Browse all Zeroqode Plugins for Bubble
Banner_Last3