ID

GraphQL Schema definition

Require by

• AccessInfoAccess information for a given resource @beta
• AnchorLocationProvides an anchor within the model to attach other information.
• AnnotationCommon interface for annotations or virtual overlays added to the model.
• AssetA binary asset associated with the model.
• BoundedRegionDetails@beta This is part of the Property Insights Beta Used to patch the collection of metadata defining a finite space in the model.
• BundleProcessingInformationCurrent information about the processing of a bundle purchase.
• ClipA video clip
• CommentMarkdown text and/or attachments made on an annotation.
• CommonAssetA binary asset associated with the model.
• CopyInputSpecification of the data to copy
• DimensionPatch@beta This is part of the Property Insights Beta Used to patch the dimensionEstimates field on rooms.
• Edge@beta This is part of the Property Insights Beta Defines an edge of a bounded region.
• EdgeDetails@beta This is part of the Property Insights Beta Used to create and patch bounded region edges.
• FloorplanA floorplan, often formatted as an image, although other options may be available.
• Folderundefined
• FolderDetailsundefined
• FolderShareAccessLevelundefined
• HighlightReelAn ordered list of assets, typically pictures, highlighting features of the model.
• Imageundefined
• IMeasurementPathPointInput structure for a point along a measurement path.
• InferenceEvent@beta This field is part of a limited access beta.
• LabelA label of a room in the model.
• LabelDetailsundefined
• LabelPatchundefined
• MattertagA point in the model with other information such as clips, photos and text associated with it.
• MattertagDetailsundefined
• MattertagPatchundefined
• MeasurementA measurement between two points within the model.
• MeasurementDetailsundefined
• MeasurementPatchundefined
• MeasurementPathA representation of measurement path made up of a sequence of points within the model. This structure is intended to replace measurements.
• MeshA 3D geometry of the model.
• ModelA digital twin, metadata and access to assets associated with a 3D model of a space.
• ModelAssetsA container for all of the assets associated with a model. The elements within this will generally implement Asset and/or AssetBundle in order to provide links for downloading the Asset. Once these links are generated they will often only be valid for a short period of time (which may be checked via `validUntil`) so they should be downloaded immediately or a new request for the url should be sent.
• ModelBundleA set of assets or features associated with a model that may be unlocked.
• ModelEventWebhookCallbackThis data is the limited set of publicly accessible information for a ModelEventWebhookCallback registration.
• ModelFloorRepresents a floor within the model. This is generally used as a navigation helper as well as a container for rooms, locations and annotations.
• ModelMlsDetailsMLS (real estate property listings) details.
• ModelPatchA patch operation on a model, updates the specified fields, leaving the others unchanged. To clear a String field, use the empty string ("").
• ModelRoomA room within the model, this acts as a container for other information.
• ModelSearchResultThis is a flattened representation of the model which removes or merges all lists of complex objects so that the fields may be directly queried. Any field on this object may be included as a keyword in the models query. For example "name: Demo" would search for models with the word Demo in the name. A search for "mattertags.labels: kitchen" would search for any models that have at least one mattertag with the word kitchen in the label.
• ModelShareAccessLevelundefined
• ModelSummaryA base interface of common fields found on the model returned from a full get or from the search results.
• ModelViewAn alternative view of the same model.
• MutationData update operations.
• NoteA point in the model for users to comment and attach other media.
• NoteDetailsundefined
• NotePatchundefined
• ObjectAnnotation@beta This field is part of a limited access beta.
• ObjectClassification@beta This field is part of a limited access beta.
• Opening@beta This is part of the Property Insights Beta Defines an opening on a bounded region edge.
• OpeningDetails@beta This is part of the Property Insights Beta Used to create and patch bounded region edge openings.
• OrganizationMetadataConcrete OrganizationSummary for representing metadata.
• OrganizationSummaryBasic metadata about an organization.
• PanoramicImageLocationundefined
• PermissionSetA permission set that can be assigned to a user group
• PhotoA photo associated with the model as well as some basic metadata including label and dimensions.
• PhotoSummaryBasic url access to a photo and the ability to retrieve it at multiple resolutions.
• PrivateModelLinkundefined
• QueryData fetch operations.
• ReelElementAn entry in the highlight reel
• ReelElementInputInput mechanism for identifying an asset to be added, removed or moved.
• Resourceundefined
• RoomAssociations@beta This is part of the Property Insights Beta Used to update the associations of annotations/locations to their rooms.
• RoomDataSelection@beta This is part of the Property Insights Beta A selector establishing what room data to update.
• RoomDetails@beta This is part of the Property Insights Beta Used to create and patch model rooms.
• SkyboxPanoramaA panoramic image broken into 6 faces: front, back, left, right, up, down The full face images may be retrieved using `urlTemplate` or `children`. Each face may also be retrieved as a set of tiles to improve progressive loading of high resolution images. In these cases the tileUrlTemplate should be used.
• TextureAn image which may be mapped onto a 3D geometry.
• UserFolderShareAccessundefined
• UserMetadataConcrete UserSummary for representing metadata.
• UserModelShareAccess Model Types
• UserSummaryBasic metadata about a user.
• Vertex@beta This is part of the Property Insights Beta Defines a single 2D point of a bounded region.
• VertexDetails@beta This is part of the Property Insights Beta Used to create and patch bounded region vertices.