Aller au contenu

Développeurs

Prismes

Vues à règles du viewer, comptes par groupe et courbe.

Lister les prismes

get/api/v1/prismes

Scope requis : models:read

La bibliothèque de prismes (vues à règles du viewer) de l'organisation, dans l'ordre choisi dans l'App. Chaque prisme dit son apparence : rules (un groupe par règle, groups donne la légende r:<rang>), value (coloration par une propriété, property et breaks ; les groupes sont les valeurs rencontrées, lus avec counts), none (périmètre seul) ou invalid (enregistrement que le moteur ne sait plus lire). tracking vaut tracked (compté à chaque nouvelle révision, d'où la courbe de history), not_tracked ou beyond_limit (suivi, mais au-delà des 12 premiers prismes que le suivi calcule). thresholds reprend les seuils communs du suivi ; les alertes posées par chaque personne n'y figurent pas. Ouvert aux plans qui incluent les prismes (403 PLAN_REQUIRED sinon) ; une organisation où les prismes ne sont pas encore ouverts répond 404. Les clés de l'organisation partagée des essais reçoivent 403 API_KEY_ROUTE_FORBIDDEN.

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 prismes.Page & object

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

curl -sS "$SEVEUP_API/api/v1/prismes" \
  -H "Authorization: Bearer $SEVEUP_KEY"
Exemple (200)
{
  "data": [
    {
      "id": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
      "name": "Charte de nommage des portes",
      "description": "Portes sans repère ou sans résistance au feu",
      "appearance": "rules",
      "property": null,
      "breaks": null,
      "groups": [
        {
          "key": "r:0",
          "label": "Portes sans repère",
          "color": "#d14343"
        },
        {
          "key": "r:1",
          "label": "règle 2",
          "color": null
        }
      ],
      "tracking": "tracked",
      "thresholds": [
        {
          "group_key": "r:0",
          "direction": "above",
          "value": 10
        }
      ],
      "created_at": "2026-11-12T08:00:00Z",
      "updated_at": "2026-11-18T16:20:00Z"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

Comptes par groupe sur une révision

get/api/v1/prismes/{prisme_id}/counts

Scope requis : models:read

Nombre d'objets par groupe du prisme sur une révision, sans aucun GlobalId (objects les liste). Clés de groupe : r:<rang> (règle, la première qui s'applique l'emporte), v:<valeur> (valeur de la propriété, v: seul pour une valeur vide, v:range:<i> pour un palier), other (valeurs au-delà des 12 plus fréquentes). unmatched compte les objets du périmètre qu'aucun groupe ne prend, out_of_scope ceux que le périmètre écarte. Une révision pas encore traitée répond 200 avec son status et available: false, jamais des comptes à zéro. Les comptes déjà notés par le suivi sont relus ; sinon le prisme est calculé, ce qui peut répondre 503 BUSY avec Retry-After quand la capacité de calcul est prise. Prisme illisible : 409.

Paramètres

  • prisme_id (path)string (uuid)requis

    Identifiant du prisme (id rendu par GET /api/v1/prismes).

  • revision_id (query)string (uuid)requis

    Révision lue (id rendu par GET /api/v1/models/{model_id}/revisions).

Réponses

  • 200Les comptes du prisme sur la révision.PrismeCounts

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

curl -sS "$SEVEUP_API/api/v1/prismes/$PRISME_ID/counts" \
  -H "Authorization: Bearer $SEVEUP_KEY"
Exemple (200)
{
  "prisme_id": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "revision_id": "4f6a1b2c-3d4e-4f50-8a6b-7c8d9e0f1a2b",
  "model_id": "9d2e7f10-6c4b-4f2a-8e11-2a7c5b3d9e01",
  "model_name": "LNPCA-S1-OA-PONT-0042-ARC",
  "revision_version": 3,
  "appearance": "rules",
  "tracking": "tracked",
  "status": "COMPLETE",
  "available": true,
  "engine": "v3",
  "total": 4412,
  "in_scope": 312,
  "out_of_scope": 4100,
  "unmatched": 280,
  "groups": [
    {
      "key": "r:0",
      "kind": "rule",
      "label": "Portes sans repère",
      "value": null,
      "from": null,
      "to": null,
      "count": 24
    },
    {
      "key": "r:1",
      "kind": "rule",
      "label": "règle 2",
      "value": null,
      "from": null,
      "to": null,
      "count": 8
    }
  ],
  "numeric": null
}

Courbe par version

get/api/v1/prismes/{prisme_id}/history

Scope requis : models:read

Courbe d'un prisme suivi : pour chaque maquette, les comptes par groupe de ses dernières versions (20 au plus), de la plus ancienne à la plus récente. Lit seulement les comptes déjà notés, sans calcul ni GlobalId. Donner model_id (une maquette) ou project_id (les maquettes du projet, paginées par limit et cursor). Une maquette sans version comptée a points: []. Un prisme non suivi (tracking: not_tracked ou beyond_limit) n'a pas de courbe : data est vide et tracking le dit. Les groupes portent les mêmes clés que counts.

Paramètres

  • prisme_id (path)string (uuid)requis

    Identifiant du prisme (id rendu par GET /api/v1/prismes).

  • model_id (query)string (uuid)

    Maquette suivie ; exclusif de project_id.

  • project_id (query)string (uuid)

    Projet dont les maquettes sont suivies ; exclusif de model_id.

  • versions (query)integer

    Versions par maquette, de 1 à 20 (20 par défaut), les plus récentes.

  • limit (query)integer

    Maquettes par page avec project_id, de 1 à 24 (10 par défaut).

  • cursor (query)string

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

Réponses

  • 200La courbe du prisme.PrismeHistory

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

curl -sS "$SEVEUP_API/api/v1/prismes/$PRISME_ID/history" \
  -H "Authorization: Bearer $SEVEUP_KEY"
Exemple (200)
{
  "prisme_id": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "name": "Charte de nommage des portes",
  "appearance": "rules",
  "tracking": "tracked",
  "engine": "v3",
  "data": [
    {
      "model_id": "9d2e7f10-6c4b-4f2a-8e11-2a7c5b3d9e01",
      "model_name": "LNPCA-S1-OA-PONT-0042-ARC",
      "points": [
        {
          "revision_id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
          "version": 2,
          "milestone": "APD",
          "created_at": "2026-11-04T10:00:00Z",
          "total": 4380,
          "in_scope": 300,
          "unmatched": 290,
          "groups": [
            {
              "key": "r:0",
              "kind": "rule",
              "label": "Portes sans repère",
              "value": null,
              "from": null,
              "to": null,
              "count": 6
            }
          ]
        },
        {
          "revision_id": "4f6a1b2c-3d4e-4f50-8a6b-7c8d9e0f1a2b",
          "version": 3,
          "milestone": null,
          "created_at": "2026-11-18T09:30:00Z",
          "total": 4412,
          "in_scope": 312,
          "unmatched": 280,
          "groups": [
            {
              "key": "r:0",
              "kind": "rule",
              "label": "Portes sans repère",
              "value": null,
              "from": null,
              "to": null,
              "count": 24
            }
          ]
        }
      ]
    }
  ],
  "next_cursor": null,
  "has_more": false
}

Objets d'un groupe

get/api/v1/prismes/{prisme_id}/objects

Scope requis : models:read

GlobalId des objets d'un groupe, triés, 200 par page par défaut et 1 000 au plus. group prend une clé rendue par counts (r:<rang>, v:<valeur>, other) ou unmatched. Une valeur que la révision ne porte pas donne un groupe vide (total: 0). Le prisme est relu ou calculé comme pour counts (503 BUSY possible). Révision pas encore traitée : 409.

Paramètres

  • prisme_id (path)string (uuid)requis

    Identifiant du prisme (id rendu par GET /api/v1/prismes).

  • revision_id (query)string (uuid)requis

    Révision lue.

  • group (query)stringrequis

    Clé du groupe (r:0, v:EI60, v:range:1, other, unmatched).

  • limit (query)integer

    GlobalId par page, de 1 à 1000 (200 par défaut).

  • cursor (query)string

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

Réponses

  • 200Une page d'objets du groupe.PrismeObjects

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

curl -sS "$SEVEUP_API/api/v1/prismes/$PRISME_ID/objects" \
  -H "Authorization: Bearer $SEVEUP_KEY"
Exemple (200)
{
  "prisme_id": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
  "revision_id": "4f6a1b2c-3d4e-4f50-8a6b-7c8d9e0f1a2b",
  "group_key": "r:0",
  "total": 24,
  "data": [
    {
      "global_id": "2O2Fr$t4X7Zf8NOew3FLOH"
    },
    {
      "global_id": "3vB2YO$MX4xv5uCqZZG05x"
    }
  ],
  "next_cursor": null,
  "has_more": false
}