App: Get hub information

Note: LOCKED.
This API is extremely reliable and will not be broken unless absolutely necessary.

Method

GET

Path

/qrs/app/{id}/hubinfo?privileges={appendPrivileges}

Description

Get the properties of an app, identified by {id}, including the virtual property availabilityStatus. QRS determines the value of the availabilityStatus property by examining the app's migration state, user and proxy headers, load balancing and synchronization rules, and engine service status. The user and proxy are identified in the X-Qlik-User and X-Qlik-ProxyId headers of the request.

Injected request headers

The possible values of the AvailabilityStatus property are:

  • 0: NotApplicable. The value is not calculated; QRS returns this value when the app is retrieved via GET /qrs/app/{id}.
  • 1: Available. The app is available for this user to open.
  • 2: NoActiveRoute. There is no running engine available. The site administrator should check the status of the nodes.
  • 3: NoConfiguredRoute. The virtual proxy the request came from has no configured engine. Check the virtual proxy configuration in the QMC.
  • 4: NotSynced. A binary synchronization has not finished. Try the request again later.
  • 5: NotMigrated. The app is not migrated to the latest format. Check QMC for details. Migration may be in progress or require administrator intervention.

Body

-

Return value

An app:

{
  "id": "a84ee815-0e8f-420e-88c5-59b2ca245561",
  "createdDate": "2016-05-25T16:09:33.940Z",
  "modifiedDate": "2016-05-25T16:09:44.387Z",
  "modifiedByUserName": "INTERNAL\\sa_repository",
  "customProperties": [],
  "owner": {
    "id": "0090aace-c52c-44c4-bd0e-1c7226373753",
    "userId": "bndbg",
    "userDirectory": "UD_CORP",
    "name": "bndbg",
    "privileges": null
  },
  "name": "ExecutiveDashboard",
  "appId": "",
  "publishTime": "1753-01-01T00:00:00.000Z",
  "published": false,
  "tags": [],
  "description": "Executive Dashboard for senior managers to monitor performance.",
  "stream": null,
  "fileSize": 1505599,
  "lastReloadTime": "2014-06-27T15:51:29.000Z",
  "thumbnail": "/appcontent/a84ee815-0e8f-420e-88c5-59b2ca245561/executive-dashboard.jpg",
  "savedInProductVersion": "2.11.0",
  "migrationHash": "f38ec476ce7db3399f32ad2cd70df0db31d06643",
  "dynamicColor": "hsla(205,18%,43%,1)",
  "availabilityStatus": 1,
  "privileges": [
    "read",
    "update",
    "delete"
  ],
  "schemaPath": "App"
}

Optional parameters

{appendPrivileges}: See Adding privileges.

Did this information help you?

Can you tell us why it did not help you and how we can improve it?