Aller au contenu

Développeurs

Tableaux de bord

Tableaux de bord (modèles de rapports de l'App) d'un espace, et modèles proposés pour en créer.

Lister les tableaux de bord d'un espace

get/api/v1/spaces/{space_id}/dashboards

Scope requis : projects:read

Tableaux de bord rangés dans l'espace (ceux de la bibliothèque de l'espace dans l'App). Ceux de portée organisation, visibles dans tous les espaces, n'y sont pas répétés.

Paramètres

  • space_id (path)string (uuid)requis

    Identifiant de l'espace (id rendu par GET /api/v1/spaces, space_id d'un projet).

  • limit (query)integer

    Taille de page.

  • cursor (query)string

    Curseur opaque rendu par la page précédente (next_cursor).

Réponses

  • 200Une page de tableaux de bord.Page & object

Erreurs communes :400401403404429500503(détail dans la section Erreurs)

curl -sS "$SEVEUP_API/api/v1/spaces/$SPACE_ID/dashboards" \
  -H "Authorization: Bearer $SEVEUP_KEY"
Exemple (200)
{
  "data": [
    {
      "id": "7e2f9a10-4b3c-4d5e-8f60-1a2b3c4d5e6f",
      "name": "Contrôle IDS LNPCA",
      "description": "Résultats des exigences IDS de vos maquettes : scores, règles, objets en échec.",
      "format": "HTML",
      "space_id": "bd52f342-c3ec-43f8-a3d0-90a7a7c0c269",
      "template_id": "00000000-0000-0000-0000-00000000a000",
      "created_at": "2026-11-12T09:00:00Z",
      "render_url": "https://www.seve-up.app/fr/library/dashboards/7e2f9a10-4b3c-4d5e-8f60-1a2b3c4d5e6f/view"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

Créer un tableau de bord dans un espace depuis un modèle

post/api/v1/spaces/{space_id}/dashboards

Scope requis : dashboards:write

Copie le modèle template_id dans l'espace, sous le nom name, au nom du créateur de la clé : comme « Dupliquer dans ce projet » de l'App (mêmes droits, même contrôle du fichier). Le modèle est un modèle du catalogue (GET /api/v1/dashboard-templates, par exemple « Conformité BIM » 00000000-0000-0000-0000-00000000a000) ou un tableau de bord de l'organisation. La copie ne suit pas les mises à jour ultérieures du modèle. Créer un tableau de bord propre à l'organisation exige un plan qui l'inclut (403 PLAN_REQUIRED sinon). Modèle inconnu, d'une autre organisation ou plus proposé : 404 TEMPLATE_NOT_FOUND ; modèle réservé non débloqué : 403 TEMPLATE_RESERVED ; espace archivé : 409. Deux tableaux de bord peuvent porter le même nom.

Paramètres

  • space_id (path)string (uuid)requis

    Identifiant de l'espace (id rendu par GET /api/v1/spaces, space_id d'un projet).

  • Idempotency-Key (header)string

    Clé d'idempotence, gardée 24 h par organisation.

Corps de la requêteDashboardCreate

  • namestringrequis

  • template_idstring (uuid)requis

    Modèle du catalogue (GET /api/v1/dashboard-templates) ou tableau de bord de l'organisation.

Réponses

  • 201Tableau de bord créé.Dashboard
  • 409Idempotency-Key déjà utilisée avec un autre corps, ou état incompatible.Problem

Erreurs communes :400401403404429500503(détail dans la section Erreurs)

curl -sS -X POST "$SEVEUP_API/api/v1/spaces/$SPACE_ID/dashboards" \
  -H "Authorization: Bearer $SEVEUP_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Contrôle IDS LNPCA",
  "template_id": "00000000-0000-0000-0000-00000000a000"
}'
Exemple (201)
{
  "id": "7e2f9a10-4b3c-4d5e-8f60-1a2b3c4d5e6f",
  "name": "Contrôle IDS LNPCA",
  "description": "Résultats des exigences IDS de vos maquettes : scores, règles, objets en échec.",
  "format": "HTML",
  "space_id": "bd52f342-c3ec-43f8-a3d0-90a7a7c0c269",
  "template_id": "00000000-0000-0000-0000-00000000a000",
  "created_at": "2026-11-12T09:00:00Z",
  "render_url": "https://www.seve-up.app/fr/library/dashboards/7e2f9a10-4b3c-4d5e-8f60-1a2b3c4d5e6f/view"
}

Lister les modèles de tableaux de bord proposés

get/api/v1/dashboard-templates

Scope requis : projects:read

Modèles du catalogue SeveUp proposés à l'organisation, à passer en template_id de POST /api/v1/spaces/{space_id}/dashboards. reserved : modèle visible mais réservé, à faire débloquer par SeveUp avant usage.

Paramètres

  • limit (query)integer

    Taille de page.

  • cursor (query)string

    Curseur opaque rendu par la page précédente (next_cursor).

Réponses

  • 200Une page de modèles.Page & object

Erreurs communes :400401403429500503(détail dans la section Erreurs)

curl -sS "$SEVEUP_API/api/v1/dashboard-templates" \
  -H "Authorization: Bearer $SEVEUP_KEY"
Exemple (200)
{
  "data": [
    {
      "id": "00000000-0000-0000-0000-00000000a000",
      "name": "Conformité BIM",
      "description": "Résultats des exigences IDS de vos maquettes : scores, règles, objets en échec.",
      "format": "HTML",
      "reserved": false,
      "published_at": "2026-10-08T09:09:07Z"
    }
  ],
  "next_cursor": null,
  "has_more": false
}