Pular para o conteúdo
Prevu3D

Encontrando seus IDs: organizações, nós e contexto

Quase todos os caminhos da API RealityConnect carregam um ID (contextId, organizationId, ownerContextIds) que precisa ser obtido antes de chamar a rota. Esta página mostra onde esses IDs vivem na árvore de nós da sua organização, como descobri-los a partir de apenas um access token, e qual família de rotas espera qual ID.

Tudo é um nó

Seção intitulada “Tudo é um nó”

O conteúdo da sua organização (divisions, sites, folders, twins, data bundles, asset libraries e mais) forma uma única árvore de data nodes. Cada nó tem um ID uuid e um DataNodeType (Organization, Division, Site, Folder, Twin, AssetLibrary, Project, SiteFile, Artifact, DataBundle). A maioria dos parâmetros de caminho que você verá na API, incluindo contextId, organizationId, nodeId, parentId e ownerContextId, são simplesmente o ID de um desses nós.

Percorrendo a árvore a partir de um token

Seção intitulada “Percorrendo a árvore a partir de um token”

Você pode ir de um access token a qualquer ID de nó da sua organização com duas chamadas:

1. Resolva o ID da sua organização

Seção intitulada “1. Resolva o ID da sua organização”
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 é a raiz da sua árvore de nós: o organizationId que a maioria das rotas espera. apiUrl é a URL base da sua API RealityConnect regional. Para a troca completa de token e como escolher o fluxo OAuth adequado, veja Getting Started.

2. Desça pela árvore a partir daí

Seção intitulada “2. Desça pela árvore a partir daí”
GET {apiUrl}/v1/nodes/{id}/browse
Authorization: Bearer <access_token>

Passe o ID da organização para ver suas divisions. Cada item da resposta é, em si, um nó com seu próprio ID e tipo; passe esse ID para a mesma rota para descer mais um nível (os sites de uma division, os folders e twins de um site, e assim por diante). Não existe um endpoint separado para “listar minhas divisions” ou “listar os twins deste site”: browse é a única chamada, repetida ao longo da árvore.

Qual ID cada família de rotas espera?

Seção intitulada “Qual ID cada família de rotas espera?”
Família de rotasIDO que identifica
/v1/twin/{contextId}/... (assets, POIs, zones, drafts, object, search, space)contextIdUm twin, o site ao qual pertence, ou um de seus drafts. Resolvido diretamente; um ID de design project ou de layout retorna 404 aqui.
/v1/reality-plan/{contextId}/... (space, model-assets, layouts, bundles)contextIdUm design project (RealityPlan Project) ou um de seus layouts. Resolvido diretamente; um ID de twin, site ou twin draft retorna 404 aqui.
/v1/nodes/{id}/browseid / nodeId / parentIdO próprio data node, no nível em que você está operando.
GET /v1/asset-library/-/models (parâmetro de consulta ownerContextIds)ownerContextIdsO(s) ID(s) do contexto dono da biblioteca: o ID da sua organização ou o de um RealityPlan Project. Não o ID de um nó AssetLibrary. Esta rota atualmente espera ao menos um valor; omiti-lo retorna 400.
/v1/asset-library/{ownerContextId}/... (parâmetro de caminho, ex.: criar/ler/atualizar um library model)ownerContextIdO mesmo de acima: a organização ou o RealityPlan Project dono da biblioteca, não o ID próprio do nó AssetLibrary.

Próximos passos

Seção intitulada “Próximos passos”