SKY API "Add parameter"

Bryce Whiteside

Hi,


My understanding is that you can only specify values for the parameters that are listed for any given REST endpoint. For example, in General Ledger, the "Account code (List)" endpoint has two possible parameters: "offset" and "limit". If I click the "Add parameter", and type in "category" and specify a value (which is one of the properties returned in the JSON for "Account code (List)"), it won't actually filter on that, correct?


I'm asking because the "Account working capitals (List)" endpoint does not specify any possible parameters, but still has the "Add parameter" link. Is this just a GUI design flaw that doesn't do anything, or should I be able to add parameters that aren't specified?


Thanks for your time,


Bryce Whiteside

Ben Lambert

Hi Bryce,


Fair question - the "Add parameter" button (and similarly, the "Add header" button) in the SKY API Console are there because the Console is intended to be a bit of a general-purpose tool, similar to Postman.  You can use it to add query parameters (or headers) to the request that is being crafted in the browser (just like you can do in Postman), but if those parameters (or headers) aren't defined/documented/supported by the API they will be ignore.  We use this periodically to help test new parameters while in development before we're ready to fully document them.  In general, you can ignore those buttons since the GUI will proactively render placeholders for any query parameters/headers that are defined for the operation.