(experimental) Create or update related dashboard interactivity

curl --request PUT \
  --url http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/interactivity \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "name": "<string>",
  "overrideVisualInteractivity": true,
  "settings": {},
  "visualSettings": {}
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/interactivity"

payload = {
    "name": "<string>",
    "overrideVisualInteractivity": True,
    "settings": {},
    "visualSettings": {}
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({
    name: '<string>',
    overrideVisualInteractivity: true,
    settings: {},
    visualSettings: {}
  })
};

fetch('http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/interactivity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/interactivity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'overrideVisualInteractivity' => true,
    'settings' => [
        
    ],
    'visualSettings' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/interactivity"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"overrideVisualInteractivity\": true,\n  \"settings\": {},\n  \"visualSettings\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/vnd.composer.v3+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/interactivity")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"name\": \"<string>\",\n  \"overrideVisualInteractivity\": true,\n  \"settings\": {},\n  \"visualSettings\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/interactivity")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"name\": \"<string>\",\n  \"overrideVisualInteractivity\": true,\n  \"settings\": {},\n  \"visualSettings\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "type": "SYSTEM",
  "overrideVisualInteractivity": true,
  "settings": {},
  "visualSettings": {}
}

(experimental) Create or update related dashboard interactivity

curl --request PUT \
  --url http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/interactivity \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "name": "<string>",
  "overrideVisualInteractivity": true,
  "settings": {},
  "visualSettings": {}
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/interactivity"

payload = {
    "name": "<string>",
    "overrideVisualInteractivity": True,
    "settings": {},
    "visualSettings": {}
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({
    name: '<string>',
    overrideVisualInteractivity: true,
    settings: {},
    visualSettings: {}
  })
};

fetch('http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/interactivity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/interactivity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'overrideVisualInteractivity' => true,
    'settings' => [
        
    ],
    'visualSettings' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/interactivity"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"overrideVisualInteractivity\": true,\n  \"settings\": {},\n  \"visualSettings\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/vnd.composer.v3+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/interactivity")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"name\": \"<string>\",\n  \"overrideVisualInteractivity\": true,\n  \"settings\": {},\n  \"visualSettings\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/interactivity")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"name\": \"<string>\",\n  \"overrideVisualInteractivity\": true,\n  \"settings\": {},\n  \"visualSettings\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "type": "SYSTEM",
  "overrideVisualInteractivity": true,
  "settings": {},
  "visualSettings": {}
}

Authorizations

Authorization

string

header

required

HTTP Basic authentication using global administrator credentials (username and password).

Path Parameters

dashboardId

string

required

Body

application/vnd.composer.v3+json

name

string

type

enum<string>

Available options:

SYSTEM,

DASHBOARD

overrideVisualInteractivity

boolean

settings

object

Show child attributes

visualSettings

object

Show child attributes

Response

200 - application/vnd.composer.v3+json

name

string

type

enum<string>

Available options:

SYSTEM,

DASHBOARD

overrideVisualInteractivity

boolean

settings

object

Show child attributes

visualSettings

object

Show child attributes

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

(experimental) Create or update related dashboard interactivity

Authorizations

Path Parameters

Body

Response