Trovare i tuoi ID: organizzazioni, nodi e contesto
Quasi tutti i percorsi dell’API RealityConnect contengono un ID (contextId, organizationId, ownerContextIds) che va prima ottenuto. Questa pagina mostra dove si trovano questi ID nell’albero dei nodi della tua organizzazione, come scoprirli partendo solo da un access token, e quale famiglia di route richiede quale ID.
Tutto è un nodo
Sezione intitolata “Tutto è un nodo”Il contenuto della tua organizzazione (division, site, folder, twin, data bundle, asset library e altro) forma un unico albero di data node. Ogni nodo ha un ID uuid e un DataNodeType (Organization, Division, Site, Folder, Twin, AssetLibrary, Project, SiteFile, Artifact, DataBundle). La maggior parte dei parametri di percorso che incontrerai nell’API, tra cui contextId, organizationId, nodeId, parentId e ownerContextId, sono semplicemente l’ID di uno di questi nodi.
Esplorare l’albero a partire da un token
Sezione intitolata “Esplorare l’albero a partire da un token”Con due chiamate puoi passare da un access token a qualsiasi ID di nodo della tua organizzazione:
1. Ottieni l’ID della tua organizzazione
Sezione intitolata “1. Ottieni l’ID della tua organizzazione”GET https://cloud-api.prevu3d.com/oauth/api-infoAuthorization: Bearer <access_token>{ "organization": { "id": "217ebd23-ec54-4af0-a6d6-4a441a6d1966", "name": "Test Organization" }, "apiUrl": "https://api-ue1.prevu3d.com/realityconnect-api"}organization.id è la radice del tuo albero dei nodi: l’organizationId richiesto dalla maggior parte delle route. apiUrl è l’URL di base della tua API RealityConnect regionale. Per lo scambio completo del token e come scegliere il flusso OAuth adatto, vedi Getting Started.
2. Scendi nell’albero da lì
Sezione intitolata “2. Scendi nell’albero da lì”GET {apiUrl}/v1/nodes/{id}/browseAuthorization: Bearer <access_token>Passa l’ID dell’organizzazione per vedere le tue division. Ogni elemento della risposta è a sua volta un nodo con un proprio ID e tipo; passa **quell’**ID alla stessa route per scendere di un altro livello (i site di una division, i folder e i twin di un site, e così via). Non esiste un endpoint separato per “elenca le mie division” o “elenca i twin di questo site”: browse è l’unica chiamata, ripetuta lungo l’albero.
Quale ID richiede ogni famiglia di route?
Sezione intitolata “Quale ID richiede ogni famiglia di route?”| Famiglia di route | ID | Cosa identifica |
|---|---|---|
/v1/twin/{contextId}/... (assets, POIs, zones, drafts, object, search, space) | contextId | Un twin, il site a cui appartiene, o uno dei suoi draft. Risolto direttamente; un ID di design project o di layout qui restituisce 404. |
/v1/reality-plan/{contextId}/... (space, model-assets, layouts, bundles) | contextId | Un design project (RealityPlan Project) o uno dei suoi layout. Risolto direttamente; un ID di twin, site o twin draft qui restituisce 404. |
/v1/nodes/{id}/browse | id / nodeId / parentId | Il data node stesso, al livello su cui stai operando. |
GET /v1/asset-library/-/models (parametro di query ownerContextIds) | ownerContextIds | Gli ID del contesto proprietario della libreria: l’ID della tua organizzazione o quello di un RealityPlan Project. Non l’ID di un nodo AssetLibrary. Questa route attualmente richiede almeno un valore; ometterlo restituisce 400. |
/v1/asset-library/{ownerContextId}/... (parametro di percorso, es. creare/leggere/aggiornare un library model) | ownerContextId | Come sopra: l’organizzazione o il RealityPlan Project proprietario della libreria, non l’ID proprio del nodo AssetLibrary. |
Prossimi passi
Sezione intitolata “Prossimi passi”- Esplora la documentazione di riferimento dell’API per gli schemi completi di richiesta/risposta.
- Vedi Searching Business Objects and Nodes per ricerche filtrate di nodi e oggetti.
- Vedi OAuth Scopes per cosa concedono
read:hierarchyewrite:hierarchy.