{
  "scriptappy": "1.0.0",
  "info": {
    "name": "AppIntegrationAPI",
    "description": "The App Integration API provides parameters that can be used to create a URL that returns a complete HTML page containing the embedded app. This URL can be embedded in a web page, for example by including it in an iFrame.",
    "version": "1.1.1",
    "stability": "stable",
    "x-qlik-since-sense": "2.2",
    "x-qlik-visibility": "public"
  },
  "entries": {},
  "definitions": {
    "URL": {
      "kind": "interface",
      "returns": {
        "description": "HTML page rendering a Qlik Sense visualization or a sheet.",
        "type": "string"
      },
      "entries": {
        "appid": {
          "description": "App ID of the referenced app.",
          "type": "string"
        },
        "sheetid": {
          "description": "Sheet ID of the referenced sheet.",
          "type": "string"
        },
        "bookmark": {
          "description": "You add a bookmark definition by stating the bookmark ID in addition to the Base URL.",
          "optional": true,
          "type": "string"
        },
        "options": {
          "description": "Add option definitions in addition to the Base URL.",
          "optional": true,
          "kind": "object",
          "entries": {
            "clearselections": {
              "description": "clearselections - Clears all selections made in the app before applying bookmarks and selections.",
              "optional": true,
              "type": "string"
            },
            "developer": {
              "description": "developer - enables developer mode in qlik-sense.",
              "stability": "experimental",
              "optional": true,
              "type": "string"
            }
          }
        },
        "select": {
          "description": "Selection definitions can be added to the Base URL. Selections can be made in a single field or in multiple fields. Multiple values are separated by a semicolon.",
          "optional": true,
          "type": "string"
        },
        "theme": {
          "description": "Add a theme definition by stating the theme ID in addition to the Base URL. Introduced in Qlik Sense 4.0",
          "optional": true,
          "type": "string"
        },
        "language": {
          "description": "Override default language settings by defining the language.",
          "optional": true,
          "type": "string"
        }
      },
      "examples": [
        "**Add a bookmark definition by stating the bookmark ID in addition to the Base URL**\n```\nhttp[s]://<machinename | servername>/{virtual proxy}/sense/app/{appid}/sheet/{sheetid}/state/analysis/bookmark/{bookmarkid}\n```\n\n**Add option definitions in addition to the Base URL**\n```\nhttp[s]://<machinename | servername>/{virtual proxy}/sense/app/{appid}/sheet/{sheetid}/state/analysis/options/{option}\n```\n\n**Selection in single field that has text representation of numeric values:**\n```\nhttp[s]://<machinename | servername>/{virtual proxy}/sense/app/{appid}/sheet/{sheetid}/state/analysis/select/{field}/{[value1];[value2]}\n```\n\n**Selections in multiple fields:**\n```\nhttp[s]://<machinename | servername>/{virtual proxy}/sense/app/{appid}/sheet/{sheetid}/state/analysis/select/{field}/{value1;value2}/select/{field2}/{value1;value2}\n```\n\n**Applying a theme:**\n```\nhttp[s]://<machinename | servername>/{virtual proxy}/sense/app/{appid}/sheet/{sheetid}/theme/{themeid}\n```"
      ]
    }
  }
}