Aller au contenu
Prevu3D

Trouver vos IDs : organisations, nœuds et contexte

Presque tous les chemins de l’API RealityConnect comportent un ID (contextId, organizationId, ownerContextIds) qu’il faut d’abord obtenir. Cette page montre où se trouvent ces IDs dans l’arborescence de nœuds de votre organisation, comment les découvrir à partir d’un simple access token, et quelle famille de routes attend quel ID.

Tout est un nœud

Section intitulée « Tout est un nœud »

Le contenu de votre organisation (divisions, sites, dossiers, twins, data bundles, asset libraries, et plus encore) forme une seule arborescence de data nodes. Chaque nœud possède un ID uuid et un DataNodeType (Organization, Division, Site, Folder, Twin, AssetLibrary, Project, SiteFile, Artifact, DataBundle). La plupart des paramètres de chemin de l’API, notamment contextId, organizationId, nodeId, parentId et ownerContextId, sont simplement l’ID de l’un de ces nœuds.

Parcourir l’arborescence à partir d’un token

Section intitulée « Parcourir l’arborescence à partir d’un token »

Deux appels suffisent pour aller d’un access token à n’importe quel ID de nœud de votre organisation :

1. Obtenir l’ID de votre organisation

Section intitulée « 1. Obtenir l’ID de votre organisation »
GET https://cloud-api.prevu3d.com/oauth/api-info
Authorization: Bearer <access_token>
{
  "organization": {
    "id": "217ebd23-ec54-4af0-a6d6-4a441a6d1966",
    "name": "Test Organization"
  },
  "apiUrl": "https://api-ue1.prevu3d.com/realityconnect-api"
}

organization.id est la racine de votre arborescence de nœuds : l’organizationId attendu par la plupart des routes. apiUrl est l’URL de base de votre API RealityConnect régionale. Pour l’échange de token complet et le choix du flux OAuth adapté, voir Getting Started.

2. Descendre dans l’arborescence

Section intitulée « 2. Descendre dans l’arborescence »
GET {apiUrl}/v1/nodes/{id}/browse
Authorization: Bearer <access_token>

Passez l’ID de l’organisation pour voir vos divisions. Chaque élément de la réponse est lui-même un nœud avec son propre ID et son propre type ; passez cet ID à la même route pour descendre d’un niveau (les sites d’une division, les dossiers et twins d’un site, etc.). Il n’existe pas d’endpoint séparé pour « lister mes divisions » ou « lister les twins de ce site » : browse est l’unique appel, répété tout au long de l’arborescence.

Quel ID chaque famille de routes attend-elle ?

Section intitulée « Quel ID chaque famille de routes attend-elle ? »
Famille de routesIDCe qu’il identifie
/v1/twin/{contextId}/... (assets, POIs, zones, drafts, object, search, space)contextIdUn twin, le site auquel il appartient, ou l’un de ses drafts. Résolu directement ; un ID de design project ou de layout renvoie 404 ici.
/v1/reality-plan/{contextId}/... (space, model-assets, layouts, bundles)contextIdUn design project (RealityPlan Project) ou l’un de ses layouts. Résolu directement ; un ID de twin, de site ou de twin draft renvoie 404 ici.
/v1/nodes/{id}/browseid / nodeId / parentIdLe data node lui-même, au niveau où vous travaillez.
GET /v1/asset-library/-/models (paramètre de requête ownerContextIds)ownerContextIdsLe ou les ID du contexte propriétaire de la bibliothèque : l’ID de votre organisation ou celui d’un RealityPlan Project. Pas l’ID d’un nœud AssetLibrary. Cette route attend actuellement au moins une valeur ; l’omettre renvoie 400.
/v1/asset-library/{ownerContextId}/... (paramètre de chemin, ex. création/lecture/mise à jour d’un library model)ownerContextIdComme ci-dessus : l’organisation ou le RealityPlan Project propriétaire de la bibliothèque, pas l’ID propre du nœud AssetLibrary.

Et ensuite ?

Section intitulée « Et ensuite ? »