Ga naar inhoud
Prevu3D

Uw IDs vinden: organisaties, nodes en context

Bijna elk pad in de RealityConnect API bevat een ID (contextId, organizationId, ownerContextIds) die u eerst moet achterhalen. Deze pagina laat zien waar die IDs zich bevinden in de node-boom van uw organisatie, hoe u ze vindt met niets meer dan een access token, en welke routefamilie welke ID verwacht.

Alles is een node

Section titled “Alles is een node”

De inhoud van uw organisatie (divisions, sites, folders, twins, data bundles, asset libraries en meer) vormt één boom van data nodes. Elke node heeft een uuid-ID en een DataNodeType (Organization, Division, Site, Folder, Twin, AssetLibrary, Project, SiteFile, Artifact, DataBundle). De meeste padparameters die u tegenkomt in de API, waaronder contextId, organizationId, nodeId, parentId en ownerContextId, zijn simpelweg de ID van een van deze nodes.

De boom doorzoeken vanaf een token

Section titled “De boom doorzoeken vanaf een token”

Met twee aanroepen komt u van een access token naar elke node-ID in uw organisatie:

1. Achterhaal uw organization-ID

Section titled “1. Achterhaal uw organization-ID”
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 is de wortel van uw node-boom: de organizationId die de meeste routes verwachten. apiUrl is de basis-URL van uw regionale RealityConnect API. Voor de volledige token-uitwisseling en het kiezen van de juiste OAuth-flow, zie Getting Started.

2. Daal van daaruit af in de boom

Section titled “2. Daal van daaruit af in de boom”
GET {apiUrl}/v1/nodes/{id}/browse
Authorization: Bearer <access_token>

Geef de organization-ID mee om uw divisions te zien. Elk item in de respons is zelf een node met een eigen ID en type; geef die ID mee aan dezelfde route om een niveau dieper te gaan (de sites van een division, de folders en twins van een site, enzovoort). Er is geen apart endpoint voor “mijn divisions weergeven” of “de twins van deze site weergeven”: browse is de enige aanroep, herhaald doorheen de boom.

Welke ID verwacht elke routefamilie?

Section titled “Welke ID verwacht elke routefamilie?”
RoutefamilieIDWat het identificeert
/v1/twin/{contextId}/... (assets, POIs, zones, drafts, object, search, space)contextIdEen twin, de site waartoe deze behoort, of een van de drafts. Wordt direct opgelost; een design project- of layout-ID geeft hier 404.
/v1/reality-plan/{contextId}/... (space, model-assets, layouts, bundles)contextIdEen design project (RealityPlan Project) of een van de layouts. Wordt direct opgelost; een twin-, site- of twin draft-ID geeft hier 404.
/v1/nodes/{id}/browseid / nodeId / parentIdDe data node zelf, op het niveau waarop u werkt.
GET /v1/asset-library/-/models (queryparameter ownerContextIds)ownerContextIdsDe ID(‘s) van de context die eigenaar is van de library: uw organization-ID of de ID van een RealityPlan Project. Niet de ID van een AssetLibrary-node. Deze route verwacht momenteel minstens één waarde; weglaten geeft 400.
/v1/asset-library/{ownerContextId}/... (padparameter, bijv. een library model aanmaken/lezen/bijwerken)ownerContextIdHetzelfde als hierboven: de organisatie of het RealityPlan Project dat eigenaar is van de library, niet de eigen ID van de AssetLibrary-node.

Wat is de volgende stap?

Section titled “Wat is de volgende stap?”