topic Re: Qlik Cloud - Change Load script through REST API in Integration, Extension & APIs

Qlik Cloud - Change Load script through REST API

prismacalota — Mon, 09 Jan 2023 16:15:19 GMT

Hello Everybody,

Is there a way to replace a loading script of an existing app via REST API in Qlik Cloud? There is the method app.setscript() via einigma.js, but unfortunately we cannot find a way directly in the REST API.

https://qlik.dev/apis/rest/apps

Thank you

Re: Qlik Cloud - Change Load script through REST API

alex_colombo — Tue, 10 Jan 2023 08:35:17 GMT

Hi @prismacalota, you cannot change reload script with REST API, you have to use Engine API. What is the use case? Why do you need to use REST API and not Engine API (or enigma.js) ?

Re: Qlik Cloud - Change Load script through REST API

prismacalota — Tue, 10 Jan 2023 12:46:08 GMT

Hello @alex_colombo ,

Communication with Qlik Cloud takes place directly from Microsoft Business Central (BC) SaaS. A websocket connection cannot be established here. Only direct REST requests via the API with OAuth are possible.

Is there an expansion planned here? Or is there another possibility?

Thank you.

Re: Qlik Cloud - Change Load script through REST API

Dave_Channon — Tue, 10 Jan 2023 13:43:21 GMT

Hi @prismacalota

To add to Alex's comments, on the product roadmap side, we are currently working on new endpoints for the apps REST API you've linked above, which we are hoping to release early in Q1 2023.

This will provide you the ability to retrieve the latest load script for an app, and post a new load script back to the app using REST & OAuth.

Re: Qlik Cloud - Change Load script through REST API

Dave_Channon — Tue, 07 Feb 2023 13:11:15 GMT

@prismacalota just a heads up that we today released the full set of endpoints for accessing and updating Qlik Sense app load scripts: https://qlik.dev/apis/rest/apps

Re: Qlik Cloud - Change Load script through REST API

Kilian — Wed, 05 Apr 2023 05:43:31 GMT

Nice to see that there are now these no endpoints.

It would be nice if we could get an additional paramter in the json request body to specify that the script should be validated before it's saved.

I would expect an 4xx errror response for cases that we are sending an invalid script.

And the response should include the validation erros in a structured form.

Currently we were using the enigma.js wrapper for the API that included the methods

setScript then we could call

checkScriptSyntax and afterwards doSave .

Re: Qlik Cloud - Change Load script through REST API

Dave_Channon — Wed, 05 Apr 2023 13:44:34 GMT

Thanks for the feedback @Kilian!

I'll take a note myself, and do please consider opening an ideation topic if you haven't already to allow others to 👍 the suggestion!

Re: Qlik Cloud - Change Load script through REST API

jainisha — Thu, 15 Feb 2024 18:33:15 GMT

Hi, I want to know do we have same endpoints for Qlik sense APIs??

Re: Qlik Cloud - Change Load script through REST API

Dave_Channon — Fri, 16 Feb 2024 13:09:05 GMT

There is no REST API to do this in Qlik Sense Enterprise Client-managed. If you're using the client managed software you should use the engine APIs to make updates in the app.

Re: Qlik Cloud - Change Load script through REST API

marksouzacosta — Fri, 16 Feb 2024 13:36:49 GMT

Hi @jainisha,

Not sure if there is an endpoint for that on Qlik Sense APIs however, if you are a .NET Developer you can make use of the QlikSense.NET SDK. There are lots of methods there to manipulate anything on Qlik Sense Apps. This is the method to set the Load Script: SetScript Method | Qlik Sense for developers Help

Re: Qlik Cloud - Change Load script through REST API

jainisha — Mon, 19 Feb 2024 21:19:06 GMT

Thanks for reply. Apart from above mentioned link.

Do you have any example or reference to see how to work with script methods?

Re: Qlik Cloud - Change Load script through REST API

Giriprasath — Tue, 27 Feb 2024 09:55:42 GMT

Hi,

I attempt to use Postman's rest API to remove the script from the Qlik Sense SaaS. However, even when I send a delete request, it remains in the app. Even after deleting the script via the rest API, the script is still there.

Re: Qlik Cloud - Change Load script through REST API

marksouzacosta — Tue, 27 Feb 2024 14:25:08 GMT

Hi @Giriprasath,

According to the documentation and my tests you can't delete the current version of the Script files:
"Deletes a specific version of the script for an app. Fails if the version to delete is the current version."

https://qlik.dev/apis/rest/apps/#%23%2Fentries%2Fv1%2Fapps%2F-appId%2Fscripts%2F-version-delete

With that said, if your intention is just to clear the current Load Script, you can use the POST Script API:
https://qlik.dev/apis/rest/apps/#%23%2Fentries%2Fv1%2Fapps%2F-appId%2Fscripts-post

The DELETE API is to delete historical changes of the Load Script.