Skip to main content

API Changelog - 2024.07.10 - 2023.04.06

2024.07.10​

July 10, 2024

Account API

  • Added options for direct and inherited access to UserAccessFilter for objectAccess query in user.schema

As part of this change, existing filter behavior is updated. If using FolderShares filter, only folders that are directly shared with the given user will be returned (previously, both direct and inherited shares will be returned as part of this filter). Similar changes are added for ModelShares, UserGroupFolderShares, and UserGroupModelShares.

2024.06.20​

June 25, 2024

Minor update:

  • Deprecated model.visibility in favor of model.accessVisibility

2024.04.25​

April 25, 2024

Layers are now partially exposed by Model API. Users can now query layers on any object and obtain a list of layers for any view. Learn More.

Password Protected and Public (available on Discover) visibilities can now be seen and set. Previously only private and unlisted were possible.

  • The new accessVisibility attribute returns private, unlisted, public or password
  • The new accessVisibilityLastChanged attribute returns the date/time when visibility was last changed.
  • The new updateModelAccessVisibility mutation will allow a user to set the visibility of a space to all four visibility options as well as set passwords on password protected spaces.
mutation UpdateModelAccessVisibility {
    updateModelAccessVisibility(id: "RHcNJBGQyzo", visibility: password, password: "test") {
        id
        accessVisibility
        accessVisibilityLastChanged
    }
}

A user may also now get the total number of scans with the model.assets.sizeEstimates attribute. This count is often used when assessing the availability or price of an add-on.

query {
    model(id: "qrsvVuvhfb6") {
        assets {
            sizeEstimates {
                scanCount
            }
        }
    }
}

Response:

{
    "data": {
        "model": {
            "assets": {
                "sizeEstimates": {
                    "scanCount": 1
                }
            }
        }
    }
}

Enterprise Only​

folder.models query now allows activationStates parameter which can be active, archived, pending or flagged. Flagged models are models that are pending approval due to being captured in unauthorized geo-blocked locations.

query Folder {
    folder(id: "BP1w3rrfjp8") {
        subfolders(pageSize: 100) {
            results {
                name
                id
            }
        }
        models(pageSize: 100, activationStates: archived) {
            nextOffset
            totalResults
            results {
                state
                name
                id
                created
                description
                address {
                    address
                }
                image {
                    resizeUrl(resolution: preview)
                }
                publication {
                    summary
                }
            }
        }
    }
}

2024.01.18​

January 18, 2024

All Users

Models can now be deleted via Model API

deleteModel(id: ID!, field: ModelIdField): Boolean mutation is now Public

Enterprise Users

This is a major revision exposing data from Property Insights. At this time, only Enterprise customers who have been enrolled in our beta can access the data.

The queries and mutations are available to all public API users, however dimensionEstimates and the room boundary data used to generate the area estimates will only be populated for models processed after the start of November 2023.

  • New Mutations: addBoundaryVertex, addBoundaryEdge, addRoom, bulkPatchRoomData, patchBoundaryVertex, patchBoundaryEdge, addEdgeOpenings, removeEdgeOpenings, patchEdgeOpening, patchRoom, deleteRoomsAndBoundaryData
  • New Queries: Model { roomClassifications, dimensionEstimates}, ModelRoom { dimensionEstimates, boundary, holes, classifications, keywords }, ModelFloor { dimensionEstimates, vertices, edges }
  • New Types / Inputs: RoomClassification, Dimensions, DimensionData, DimensionPatch, DimensionDataPatch, BoundedRegion, Vertex, Edge, Opening, BoundedRegionDetails, VertexDetails, EdgeDetails, OpeningDetails, RoomDetails, RoomAssociations, RoomDataSelection
  • New Enums: RoomDataType, OpeningType, EdgeType

2023.11.15​

November 15, 2023

Views are now a part of Model API! Documentation

  • mutations: addView, deleteView, and copyViewData
  • queries: model.views

2023.08.08​

August 8, 2023

  • Private Model Embed (PME) no longer requires also having the OAuth feature enabled on the organization. Nothing changes from a usage perspective.

2023.07.20​

July 20, 2023

Account API

  • Add lastLogin field to Membership (UserMembership) type

2023.06.28​

June 28, 2023

Account API

  • Add UnitType enum with imperial and metric values.
  • Add unitType to Organization, OrganizationSettings and OrganizationSettingsInput types.

2023.05.16​

May 16, 2023

  • A new BillingDetails under model, containing exempt: Boolean and multiSpaceUse
    • multiSpaceUse is the number of spaces counted against your space quota
    • Models on Classic Accounts or that were uploaded to accounts before entering into our new billing plans will always have a multiSpaceUse value of 1
  • The Mutation updateModelState now accepts an allowActivate boolean which defaults to false.
    • This must be set to true to unarchive models on accounts that would incur reactivation charges.
    • If this is unspecified or set to false on an account that would incur reactivation charges a request.unsupported error code will be returned.

2023.04.06​

April 6, 2023

  • Users with Folder API Access can now query folder paths within model queries.
query getModelFolder {
  model(id: $modelId) {
    folders {
      id
      depth
    }
  }
}