(experimental) Convert dashboards layout

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/dashboards/convert-layout \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "dashboardIds": [
    "<string>"
  ],
  "targetLayout": "RESPONSIVE"
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/dashboards/convert-layout"

payload = {
    "dashboardIds": ["<string>"],
    "targetLayout": "RESPONSIVE"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({dashboardIds: ['<string>'], targetLayout: 'RESPONSIVE'})
};

fetch('http://10.2.4.166:8080/composer/api/dashboards/convert-layout', 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/convert-layout",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dashboardIds' => [
        '<string>'
    ],
    'targetLayout' => 'RESPONSIVE'
  ]),
  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/convert-layout"

	payload := strings.NewReader("{\n  \"dashboardIds\": [\n    \"<string>\"\n  ],\n  \"targetLayout\": \"RESPONSIVE\"\n}")

	req, _ := http.NewRequest("POST", 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.post("http://10.2.4.166:8080/composer/api/dashboards/convert-layout")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"dashboardIds\": [\n    \"<string>\"\n  ],\n  \"targetLayout\": \"RESPONSIVE\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/dashboards/convert-layout")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"dashboardIds\": [\n    \"<string>\"\n  ],\n  \"targetLayout\": \"RESPONSIVE\"\n}"

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

{
  "dashboards": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "visuals": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "sources": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "uploads": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "visualTypes": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "connections": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "snippets": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "calendars": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ]
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

(experimental) Convert dashboards layout

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/dashboards/convert-layout \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "dashboardIds": [
    "<string>"
  ],
  "targetLayout": "RESPONSIVE"
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/dashboards/convert-layout"

payload = {
    "dashboardIds": ["<string>"],
    "targetLayout": "RESPONSIVE"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({dashboardIds: ['<string>'], targetLayout: 'RESPONSIVE'})
};

fetch('http://10.2.4.166:8080/composer/api/dashboards/convert-layout', 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/convert-layout",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dashboardIds' => [
        '<string>'
    ],
    'targetLayout' => 'RESPONSIVE'
  ]),
  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/convert-layout"

	payload := strings.NewReader("{\n  \"dashboardIds\": [\n    \"<string>\"\n  ],\n  \"targetLayout\": \"RESPONSIVE\"\n}")

	req, _ := http.NewRequest("POST", 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.post("http://10.2.4.166:8080/composer/api/dashboards/convert-layout")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"dashboardIds\": [\n    \"<string>\"\n  ],\n  \"targetLayout\": \"RESPONSIVE\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/dashboards/convert-layout")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"dashboardIds\": [\n    \"<string>\"\n  ],\n  \"targetLayout\": \"RESPONSIVE\"\n}"

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

{
  "dashboards": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "visuals": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "sources": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "uploads": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "visualTypes": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "connections": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "snippets": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ],
  "calendars": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "CREATED",
      "href": "<string>",
      "dependencies": [
        {
          "type": "DASHBOARD",
          "id": "<string>"
        }
      ],
      "problems": [
        {
          "name": "<string>",
          "message": "<string>",
          "level": "ERROR",
          "dependencies": {}
        }
      ]
    }
  ]
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/vnd.composer.v3+json

Dashboard conversion payload

dashboardIds

string[]

required

targetLayout

enum<string>

required

Available options:

RESPONSIVE

Response

The dashboards were converted

Defines result of dashboard import

dashboards

object[]

Defines imported dashboards

Show child attributes

visuals

object[]

Defines imported visuals

Show child attributes

sources

object[]

Defines imported sources

Show child attributes

uploads

object[]

Defines imported uploads

Show child attributes

visualTypes

object[]

Defines imported visual types

Show child attributes

connections

object[]

Defines imported connections

Show child attributes

snippets

object[]

Defines imported snippets

Show child attributes

calendars

object[]

Defines imported calendars

Show child attributes

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

(experimental) Convert dashboards layout

Authorizations

Body

Response