Optional viewer: AtlasViewerProtected _attrProtected attributeOptional description?: stringDescription
A description of your project.
Optional is_Is Public
Is the project public?
false
Optional is_Is Public To Org
Is the project public to the organization?
Optional modality?: stringModality
The data modality of this project
Organization Id Format: uuid
Unique organization id
33adcf85-84ed-4e3a-9519-17c72682f905
Project Name
The name of the project
example-project
Optional slug?: stringSlug
The desired url slug for the project
Unique Id Field
The unique ID field of the project.
Protected endpointFetches basic information about the object.
By default, this caches the call; if you want to
bust the cache, pass true as the first argument.
This immediately.
Whether to refetch the relevant information
A promise that resolves to the organization info.
Loads the information associated with the class, removing any existing caches.
a LoadedObject instance of the class that is guaranteed to
have its attr slot populated with appropriate information.
const loadedProject = await (new AtlasProject(projectId)).withLoadedAttributes()
// OR, in cases where we want to do stuff immediately with the project and ensure
// that later calls there don't double-fetch information.
const project = new AtlasProject(projectId)
// do stuff right away.
const projection = new AtlasProjection(projectionId, {project: project})
const loadedProjection = await projection.withLoadedAttributes()
// do stuff with loadedProjection
returns the object's information; this may be undefined