Terminology

Also referred to as Client Account ID, this is the identifier for your client account.

It is not your personal user account that you use to login.

To figure out what your account ID is, you can refer to your Nextspace account links.

For example, if your account link is: https://my-account.nextspace.host/ then your account ID is my-account.

Also referred to as ssid, this is the identifier for your session.

You can attach it to the request-header x-sessionid when making requests to the Nextspace API to authenticate them.

Also referred to as Env, this is the identifier used to differentiate between different versions of the Nextspace services.

The most common two you will work with are UAT and PROD.

As of writing this, we recommend using UAT for development as production is significantly out of date.

DEV and STG are for Nextspace developers only. Please ignore them.

Entities are the core of Nextspace. An Entity is a record that can represent anything based on your own level of categorization, attribution, and tagging.

Examples of Entity records can be a certain building, a person, or a vehicle.

Below is a minimal example of an Entity record.

interface IEntity {
    // Bruce is a code-word for the Nextspace API.
    // These are internal fields.
    Bruce: {
        ID: string,
        "EntityType.ID": string,
        "CreatedBy.User.ID": string,
        "Layer.ID": number[],
        Created: string;
    }

Entity Types are used to categorize and describe Entities.

For example you make a generic category 'Building' and describe what attributes you'd like any building in your account to have.
Attributes such as 'Name', 'Address', 'Owner', etc.

Tilesets can be thought of as 'optimized for rendering' graphics.

They are most commonly used in Nextspace to render CAD, BIM, Point cloud, terrain, and other types of data.

Project Views are saved configurations for what is available to be rendered by a user.

For example you may import a few files into your account, then setup a Project View to showcase or manage one or many of those imports.

Project Views contain Bookmarks, these are saved Views of the data.
Think of them like powerpoint slides that show where to look and what data is enabled.

A Menu Item is an 'action' that a Project View can perform.

For example the action might be to load a Point Cloud, or to render buildings around the view-port.