Manuel de référence

# API REST

# Liste des tableaux de bord

# URL

GET /api/v2/dashboard/list

# Structure de retour

Le retour est une donnée JSON.

# En cas de réussite

La section data correspond à la liste des tableaux de bord auquel a accès l'utilisateur connecté. Il contient les informations utiles sur chacun d'entre eux (plus de détails ici)

Exemple :

{
  "success": true,
  "data": [
    {
      "uuid": "e499f206-6e05-4cd7-8049-b1ae89a3cc1c",
      "title": "Titre1",
      "published": false,
      "changed_on": "2023-04-28T12:21:30.599457",
      "changed_by_name": "Superset Admin",
      "slug": "ref1",
      "url": "http://<supersetServer>/superset/dashboard/ref1",
      "domain": "http://<supersetServer>",
      "owners": [
        { "id": "id1", "displayName": "Role Name1", "login": "role_login1" },
        { "id": "id2", "displayName": "Role Name2", "login": "role_login2" }
      ]
    },
    {
      "uuid": "a499f206-6e05-4cd7-8049-b1ae89a3cc1c",
      "title": "Titre2",
      "published": true,
      "changed_on": "2023-04-28T10:21:30.599457",
      "changed_by_name": "Superset Admin",
      "slug": "ref2",
      "url": "http://<supersetServer>/superset/dashboard/ref2",
      "domain": "http://<supersetServer>",
      "owners": []
    }
  ]
}

Information

La liste des rôles autorisés à le consulter (ici owners) est visible uniquement si la requête est effectuée par un dashboard-admin.

# En cas d'échec

Les raisons d'échec spécifiques à cette requête sont :

Raison Statut HTTP
Échec de la connexion à Superset 500 Internal Server Error

# Information sur un tableau de bord

# URL

GET /api/v2/dashboard/info?ref=<reference>

# Structure de retour

Le retour est une donnée JSON.

# En cas de réussite

Elle contient les informations suivantes concernant le tableau de bord identifié par <reference> :

Champ Description
changed_by_name qui a effectué la dernière modification
changed_on la date de dernière modification
domain l'URL du serveur Superset
owners la liste des rôles autorisés à le consulter avec pour chacun leur displayName et login
published son statut (publié ou non)
slug son identifiant unique dans AP4
title son titre
url l'URL Superset où le consulter
uuid son identifiant unique dans Superset

Exemple :

{
  "success": true,
  "data": {
    "uuid": "e499f206-6e05-4cd7-8049-b1ae89a3cc1c",
    "title": "Titre1",
    "published": false,
    "changed_on": "2023-04-28T12:21:30.599457",
    "changed_by_name": "Superset Admin",
    "slug": "ref1",
    "url": "http://<supersetServer>/superset/dashboard/ref1",
    "domain": "http://<supersetServer>",
    "owners": [
      { "displayName": "Role Name1", "login": "role_login1" },
      { "displayName": "Role Name2", "login": "role_login2" }
    ]
  }
}

Information

La liste des rôles autorisés à le consulter (ici owners) est visible uniquement si la requête est effectuée par un dashboard-admin.

# En cas d'échec

Les raisons d'échec spécifiques à cette requête sont :

Raison Statut HTTP
Référence du tableau de bord non spécifiée 400 Bad Request
Échec de la connexion à Superset 500 Internal Server Error
Accès au tableau de bord refusé 403 Forbidden

← Composant DashboardViewer →