Board API Query Output JSON format

Anuj Gupta

Ask is to update the json output format of the REST API queries so as to get column header and data in a single block, as opposed to headers in the columns block and data in a separate data block.
This will make it easier for Customer's application to consume the query output.
Attached images of current vs expected query output JSON formats.

Nicolas BENDONGUE

Hi, there were a paramater that could be passed into the query syntax which allowed to repeat all keys (columns) in the data section But it look likes this query parameter has been deprecated

Here is the link were I found this https://www.boardmanual.com/2021/summer/administration/Subscription_Hub/1_Users/Client_API.htm?rhhlterm=api%20apis&rhsearch=api

Andrea Duò

Hi @Anuj Gupta ,

@Nicolas BENDONGUE is right. Actually, the parameter works and is not deprecated.

Andrea

Nicolas BENDONGUE

Hi @Andrea Duò, I tried to use the parameter but I have an error message.

I'm using Postman for testing.

Any idea? May be I don't use it properly.

Thanks

Andrea Duò

Hi @Nicolas BENDONGUE,

I think you do not need the last “/”.

Your URL should be “https://…./query/Test?json=full”

Andrea

Nicolas BENDONGUE

Hi @Andrea Duò ,

Still KO

Thanks

Andrea Duò

Hi @Nicolas BENDONGUE ,

I would recommend opening a case on our Support portal so we can get in touch to investigate further. It could be that there is an issue on the underlying layout or the data it exposes.

Thanks!

Andrea

Nicolas BENDONGUE

Hi @Andrea Duò

Already done since Yesterday 😊

Thanks,

Regards

Nicolas BENDONGUE

Hi @Andrea Duò, @Anuj Gupta ,

Following the migration from Board 12.2 to Board 12.5, the query parameter ?json=full works well. It seems that there was a bug on Board 12.2 for this feature.

Enjoy !

Regards

Product Management Team

Thank you for sharing your idea, Anuj. We appreciate the time and effort you put into crafting your suggestion. Great news, this feature is available from the Summer 2023 release. Here is the link to the manual for the REST API enhancements:
https://www.boardmanual.com/2021/summer/whats-new-release-notes/2023-summer-release/main-features/rest-api-call-procedure-step-enhancements.htm