topic Re: QRS API property availabilityStatus in Integration, Extension & APIs

QRS API property availabilityStatus

francisco_rivas — Wed, 26 Sep 2018 17:44:18 GMT

Hi,

I've been interacting with the QSR API through CURL or Postman and I have been able to connect without problems. When I was reviewing the endpoints, I find that there is an API called App: Get hub information which determines the value of a property called 'availabilityStatus'. This property, according to the documentation, has different states of the application, so it is useful when knowing its availability.

However, at the time of executing the API, it always returns the value zero (0) and there is no way to return status 1, which is when the application is fine. I have also tried downloading the Engine service so that it returns me status 2 but neither does it.

According to the documentation, when the application is recovered via GET, the 'AvailabilityStatus' values are always zero (0). But I do not understand how to call the API in another way so that it returns the correct values.

Documentation:

https://help.qlik.com/en-US/sense-developer/September2018/Subsystems/RepositoryServiceAPI/Content/Sense_RepositoryServic…

Thank you for your help

Regards

Francisco

Re: QRS API property availabilityStatus

ErikWetterberg — Wed, 26 Sep 2018 19:25:30 GMT

‌Hi,

You could try the hublist:

https://help.qlik.com/en-US/sense-developer/September2018/Subsystems/RepositoryServiceAPI/Content/Sense_RepositoryServic…

Erik Wetterberg

https://extendingqlik.upper88.com/

Re: QRS API property availabilityStatus

francisco_rivas — Wed, 26 Sep 2018 21:27:23 GMT

Hi Erik,

Thank you for your answer

Also the hublist (which is a GET Method) returns the 'availabilityStatus' equal to zero (0). Maybe it's the way to call the property.

Have you tried this functionality?

Regards

Francisco

Re: QRS API property availabilityStatus

ErikWetterberg — Thu, 27 Sep 2018 08:46:34 GMT

Hi,

No I haven't, I use /qrs/app/full for listing apps. It looks like the Qlik Sense hub uses /api/hub/v0/apps, which I don't beleive is public, but it does seem to include availabilityStatus.

Erik Wetterberg

https://extendingqlik.upper88.com/

Re: QRS API property availabilityStatus

francisco_rivas — Thu, 27 Sep 2018 12:53:43 GMT

Hi,

And how do you use /api/hub/v0/apps ?

https://ServerName:4242/api/hub/v0/app/?Xrfkey=0123456789abcdef

Thank you

Francisco

Re: QRS API property availabilityStatus

Levi_Turner — Thu, 27 Sep 2018 17:20:05 GMT

That endpoint needs to go through the Proxy unfortunately.

So this works using Qlik-CLI:

$Data = Get-Content C:\ProgramData\Qlik\Sense\Host.cfg
$FQDN = [System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($($Data)))
Connect-Qlik -Computername $($FQDN) -UseDefaultCredentials
Invoke-QlikGet -path /api/hub/v0/apps

What is your end-goal? To determine which apps are load balanced to the Engines bound to a particular virtual proxy?

Re: QRS API property availabilityStatus

francisco_rivas — Thu, 27 Sep 2018 18:39:03 GMT

Hi Levi,

My end-goal is to determine the status of a particular application. In other words, know if it is available for the user to open. When there is no running engine available, this condition has to be detected. The property 'availabilityStatus' delivers this status.

I managed to do this in Curl and it works.

curl -v -L --ntlm --negotiate -u User:Pass --insecure https://ServerName/api/hub/v0/apps/{id} --header "User-Agent: Windows"

Only it works through the Proxy ?

Thank you for your help

Regards

Francisco