Gamma API

Projects

Create projects, decide who works on them and with what rights, set up their notifications and GPS, follow what happens in them, and download exports.

A project is where an organization's work on one building or site lives: its models, markers, issues, forms and progress tracking, and the people who work on them. Every project belongs to one organization.

This page covers the project itself: creating it, putting people on it, its settings, the activity log, exports, and archiving or deleting it. The content inside a project has its own pages: Models, Views, Search sets, Markers, Issues, Forms and Progress.

Who can do what

Two things decide what you can do in a project:

  • Your access level on the project. A project Admin manages the project: its members, invitations and settings. A Member does not. Organization owners, security admins and admins manage every project in their organization, whether or not they are on its member list. A project creator becomes the admin of each project they create.
  • Your profile on the project. A permission profile decides what you may do with the content: models, markers, issues, forms, form templates and element statuses, each at No access, View, Create, Edit or Full control. Organization owners and admins hold every right on every project, whatever profile they have.

The two are separate. A project admin with a read-only profile runs the project but only reads its issues; a member with a full profile can delete issues but cannot add people.

TaskOrganization owner / security admin / adminProject adminProject member
See the project in listsAll projectsProjects they are onProjects they are on
Create a projectYesOnly if they are a project creator in the organizationOnly if they are a project creator in the organization
Rename or change the descriptionYesNoNo
Archive or unarchiveYesYes (in Settings)No
Delete or restore a projectYesNoNo
Add and remove members, change access levels and profilesYesYesNo
Invite a guest to the projectYesYesNo
Dashboard, Activity, Emails, JobsYesYesNo
Change the widgets on Issues → ChartsYesYesNo (sees them with Issues at View or above)
Settings: General, GPS, NotificationsYesYesNo
Create, edit, reorder and delete tagsYesYesNo (reads them)
Work with models, issues, forms and the restEverythingAs their profile allowsAs their profile allows

A guest is someone from outside the organization who was invited to one project and has access to nothing else.

Opening a project

Your home page lists every project you can open, across all your organizations. Inside an organization, Projects lists that organization's projects.

A project has no overview page of its own. Opening it takes you straight to a section:

  • The Opens in column on the home page lets you pick that section per project, for example Issues for a project you mostly triage.
  • Without a choice, the project opens on the first section you may read, usually Models.
  • If your profile does not let you read any section, you see "Nothing to show yet". Ask a project admin for a profile.

The menu on the left is grouped as Project (Models, Markers, Issues, Forms), Tracking (Progress), Monitoring (Dashboard, Activity, Jobs) and Admin (Members, Settings). Sections your profile cannot read are left out. Monitoring and Admin only appear for people who manage the project. To move to another project, use the project switcher in the header; it keeps you in the same section, so Issues takes you to the other project's Issues.

Create a project

Only organization owners and admins can create projects.

Open the organization's Projects page and click New project. You can also click New project on your home page; if you can create projects in more than one organization, pick the Organization first.

Enter a Name. It must be unique within the organization. A Description is optional.

Click Create project.

A new project comes with a default issue schema ("General") and default element statuses, so issues and progress tracking work from the start. They are named in the language of whoever creates the project, and are the team's to rename from then on. Members and models are added afterwards.

A deleted project keeps its name until it is gone for good. If "already exists" comes up for a name you cannot see, an owner or admin can find the deleted project in the list and restore it.

Add people to a project

Project admins and organization owners and admins do this from Members. One sheet covers both people already in the organization and people outside it.

Open Members and click Add people.

Search by name or email. Pick the organization members you want to add. To bring in someone from outside, type their full email address and choose Invite ... as a guest.

Choose the Access level (Admin or Member) for the people picked from the organization, and a Profile. If you leave the profile on Default for the access level, admins get Manager and members get Viewer.

Click the button at the bottom. It says what will happen: Add to project, Send invitation, or Add and invite when you do both.

Organization members are on the project at once. An invited guest gets an email and only appears in the list once they accept. Invited guests always join with the Member access level; you can raise it afterwards. An invitation expires 48 hours after it was sent.

You cannot invite an address that already belongs to someone in the organization, or one that already has a pending invitation. Add the existing member instead, or wait for the pending invitation to be answered or cancelled.

An organization can have at most 100 pending invitations, counting its own and the guest invitations of all its projects together. When it is full, the invitation is refused; cancel invitations nobody is going to answer, here or in the organization's Members, and try again.

Manage members

The Members table lists everyone on the project and the invitations waiting on an answer. Filter by status (members, guests, invited), access level or profile, or search by name or email.

  • Change an access level or profile: use the two selects on the person's row. The change applies straight away.
  • Remove someone: use the remove button on their row and confirm. They stay in the organization and can be added back later. For a guest, removing them from their only project ends their access, although their organization membership stays.
  • Cancel an invitation: use the cancel button on the invitation row. The link in their email stops working, and you can invite them again at any time.

A project admin can demote themselves. Organization owners and admins can always manage the project, so it is never left without anyone who can fix it.

Project settings

Settings has three tabs: General, GPS and Notifications. Only people who manage the project see them.

General

Under Project information, change the Name and Description and click Save changes. The Danger zone holds:

  • Archive this project: the project stays listed and readable, marked Archived. Click Unarchive to put it back. Nothing is lost either way.
  • Delete this project: only shown to organization owners and admins. See Delete and restore.

How uploaded models are converted (2D content, Autodesk material colors) is set under Models → Settings; see Models.

GPS

Two cards, each with its own Cancel and Save changes:

  • GNSS configuration: the Coordinate system (paste a WKT, WKT2 or PROJ4 definition; empty means WGS 84), the Geoid model (EGM2008, EGM96, or None - ellipsoidal height; EGM2008 is the default), Use survey foot, and a Manual height offset (m) added to every height after the geoid.
  • Default NTRIP configuration: the caster's Host and Port, then Test connection to load its mount points and pick one under Mount point. Add Username and Password if the caster needs them.

The password is never shown again after you save it. The field reads "Saved — leave blank to keep". Only public addresses can be tested.

Notifications

This decides how often the project's members are emailed about work that concerns them, and whether they are told at all. The setting is the project's and the same for everyone on it.

Under Tools and notification types, set a Frequency for each type: Issue created or assigned to you, Form assigned to you, Form sent to you for review (to the people who may approve it) and Your form approved or rejected (to whoever submitted it). Choose Instantly, Hourly, Daily, Weekly or Never. The default is Instantly.

Under Digest schedule, set the Hour (for daily and weekly digests), the Day (for weekly digests) and the project's Time zone.

Save. Emails already waiting for a digest move to the new schedule. If you switch a type to Never, its waiting emails are dropped. If you switch it to Instantly, they go out now.

Hourly, daily and weekly emails are collected into one digest per person per project. The hour is read in each person's own account time zone if they have set one, and in the project's time zone otherwise. People are never emailed about their own changes.

The same setting covers the notification panel under the bell. Whatever the frequency, the panel shows the notification straight away; only the email waits for the digest. Never turns off both.

Dashboard

Monitoring → Dashboard (G then D) is the project's own dashboard of widgets, for whoever manages the project. It starts with the open issues by status, the project's changes over time, its storage in all and by kind of file, and its forms by status. Anyone who manages the project can add widgets, change them, resize, move and remove them; the widgets that read issues or forms are only offered if your profile lets you read them.

Follow what happens: Activity and Emails

Activity is for project admins and organization owners and admins. Other members see a record's history on the record itself.

Activity lists every change to the project's issues, forms, models, views, search sets, markers, tracked elements and members, plus what people did to its jobs, newest first. For models that means uploads, new versions, renames, moves to another folder and deletes, under Models. Model changes made before this was added are not listed. Filter by record type, action, who made the change (By), and a From and To date. Click a row to see exactly which fields changed and to open the record. If your own profile cannot read an area, for example forms, those changes are left out for you too.

Activity → Emails lists every email the project has sent or queued: issue and form assignments, forms sent for review, form decisions, finished exports, each alone or in a digest, and guest invitations. Each row shows the recipient, what the email was about, who caused it and its status: Sent, Queued (with the time it is due) or Failed (with the mail provider's error). Filter by type, status, date, or part of the recipient's address. This is where you check whether someone actually got an email.

Exports

The issues PDF, the markers PDF and the element status report are made in the background, so a large one does not hold up the page. You start them from Issues, Markers and Progress → Elements or the Dashboard; see Issues, Markers and Progress.

Choose the export. The page says "Export started" and you can carry on working.
When the file is ready you get a notification under the bell and an email, both with a link.
The link opens the export's page, which starts the download. If you open it before the file is ready, it waits and starts the download when it is.
  • Seven days. The file and its link last 7 days. After that the page says the export has expired; export again to get a new one.
  • Only for you. The link works only for the person who asked for the export.
  • If it fails, you get a notification instead and the export's page says so. Try again from the list. A project admin can see the reason under Jobs, where every export is listed beside the model conversions.
  • Limits. One export takes up to 2,000 issues, 1,000 markers or 500,000 element rows. For more, export in parts: select fewer issues or markers, or narrow the status report's filters.
  • The file is written in your language and time zone, and kept in your organization's storage.

Tags

Tags are named, colored labels that file the project's models. Everyone on the project can see them; project admins and organization owners and admins manage them under Models → Tags: New tag, rename, change the Color, drag to reorder, or delete. A tag name must be unique within the project, up to 50 characters.

Attachments

Files can be attached to issues, forms and markers. They work the same everywhere: drop files on the attachments block or click to add, and remove them from the list. Images open in a viewer where you can step through the record's other images or open the original in a new tab; other files open in a new tab.

  • One file can be up to 25 MB. A PDF attached to a form as a whole can be up to 50 MB.
  • Whether you can add or remove files depends on your rights on the record. A form, for example, only takes files in certain states; see Forms.
  • Files stay readable after their record is deleted.

Delete and restore

Only organization owners and admins can delete a project, from Settings → General or from the project's sheet in the organization's Projects list.

  • The project disappears for everyone at once. Nobody loses their place in the organization.
  • Its pending invitations are cancelled. Restoring the project does not bring them back.
  • For 30 days, owners and admins still see it in the Projects list, marked as deleted with the date it will be gone. Open it and click Restore project to bring it back as it was.
  • After 30 days it is deleted for good, with its models, history and every file in it, including files kept in the organization's own storage.

Good to know

  • Removing a person from a project keeps their history: the Activity log still shows what they did and when they were added or removed.
  • Adding someone who is already on the project does nothing; they keep their current access level and profile.
  • Archiving changes nothing but the label. Archived projects stay open and editable.

For scripts and integrations, see the API reference for projects, project members, project settings, activity, tags and attachments.

On this page