Apps

Download OpenAPI spec

Restore an application

Restores a soft-deleted Qlik Cloud Analytics application to the same space with the same app ID, retaining the properties it had at the time of deletion. This operation is available to the app owner and Tenant Admins. The app owner can restore the app only if the original space still exists and they still have delete permission in the space; otherwise, a 403 Forbidden error is returned. Associated resources such as data alerts, subscriptions, collections, notes, and tags are deleted when the app is deleted and cannot be restored.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • appIdstring
    Required

    Identifier of the app.

Responses

200

OK

  • application/jsonobject

    Application attributes and user privileges.

    Show application/json properties
    • createarray of objects

      Object create privileges. Hints to the client what type of objects the user is allowed to create.

      Show create properties
      • resourcestring

        Type of resource. For example, sheet, story, bookmark, etc.

      • canCreateboolean

        Is set to true if the user has privileges to create the resource.
    • attributesobject

      Application attributes.

      Show attributes properties
      • idstring

        The App ID.

      • namestring

        App name.

      • statestring

        Promotion state of the app. Promotion state of an app. One of:

        • EMPTY
        • PROMOTED
        • DISTRIBUTED

        Can be one of: "EMPTY""PROMOTED""DISTRIBUTED"

      • usagestring

        Indicates the use for the app.

        One of:

        • ANALYTICS
        • DATA_PREPARATION
        • DATAFLOW_PREP
        • SINGLE_TABLE_PREP
        • DIRECT_QUERY_MODE

        Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"

      • ownerIdstring

        Identifier of the app owner.

      • spaceIdstring

        The ID of the app's space.

      • createdAtstring

        The date and time when the app was created.

        format = "date-time"

      • updatedAtstring

        The date and time when the app was modified.

        format = "date-time"

      • promotedAtstring

        The date and time when the app was promoted, empty if not promoted. Use to determine if an app is promoted in Qlik Cloud.

        format = "date-time"

      • reloadedAtstring

        Date and time of the last reload of the app.

        format = "date-time"

      • descriptionstring

        App description.

      • originAppIdstring

        The Origin App ID for promoted apps.

      • resourceTypestring

        App resource type.

      • hasSectionAccessboolean

        If set to true, the app has section access configured.
    • privilegesarray of strings

      Application privileges. Hints to the client what actions the user is allowed to perform. Could be any of:

      • read
      • create
      • update
      • delete
      • reload
      • import
      • publish
      • duplicate
      • export
      • exportdata
      • change_owner
      • change_space

400

Bad request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      Array of all errors that occurred during the request.

      Show errors properties
      • codestring
        Required

        A unique code for the error.

      • titlestring
        Required

        A human-readable description of the error.

      • detailstring

        Additional information about the error.

401

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      Array of all errors that occurred during the request.

      Show errors properties
      • codestring
        Required

        A unique code for the error.

      • titlestring
        Required

        A human-readable description of the error.

      • detailstring

        Additional information about the error.

403

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      Array of all errors that occurred during the request.

      Show errors properties
      • codestring
        Required

        A unique code for the error.

      • titlestring
        Required

        A human-readable description of the error.

      • detailstring

        Additional information about the error.

404

Not Found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      Array of all errors that occurred during the request.

      Show errors properties
      • codestring
        Required

        A unique code for the error.

      • titlestring
        Required

        A human-readable description of the error.

      • detailstring

        Additional information about the error.
POST /api/analytics/apps/{appId}/actions/restore 
// qlik-api has not implemented support for `POST /api/analytics/apps/{appId}/actions/restore` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/analytics/apps/{appId}/actions/restore',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
# qlik-cli has not implemented support for POST /api/analytics/apps/{appId}/actions/restore yet.
curl "https://your-tenant.us.qlikcloud.com/api/analytics/apps/{appId}/actions/restore" \
-X POST \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ],
  "attributes": {
    "id": "string",
    "name": "string",
    "state": "string",
    "usage": "string",
    "ownerId": "string",
    "spaceId": "string",
    "createdAt": "2019-01-01T00:00:00.000Z",
    "updatedAt": "2019-01-01T00:00:00.000Z",
    "promotedAt": "2019-01-01T00:00:00.000Z",
    "reloadedAt": "2019-01-01T00:00:00.000Z",
    "description": "string",
    "originAppId": "string",
    "resourceType": "string",
    "hasSectionAccess": true
  },
  "privileges": [
    "string"
  ]
}