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?
Hey @ch-schroeder ,
Thank you for contacting us.
Here’s a breakdown of these options:
- 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.
- 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.
- Querystring:
-
What it does: This checkbox specifies that the parameter will be included in the query string of the API request (like appending
?key=valueto 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
I mean this
Hey @ch-schroeder ,
Thank you for your reply.
Your screenshot is too low quality to understand what it says.
Please note that we provide general support for our plugins and do not offer consultancy or customization services.
We recommend reviewing the demo page for workflow examples and carefully reading the supporting documentation for successful plugin integration.
If you’re looking for a team to assist with customization, you can consider hiring Zeroqode. By sharing your project details and budget, one of our project managers will get back to you with an estimate.
Best Regards,
Anton
That’s exactly what I did, this is a screenshot from your documentation. These three checkboxes are ticked and I would like to know whether this is really necessary for the functionality of the plugin or whether you simply left the checkboxes activated when creating the documentation.
Hey @ch-schroeder ,
Thank you for your reply.
Yes, those checkboxes were left for documentation and nothing more, the plugin allows you to work even if all those checkboxes are unselected.
Best Regards,
Anton