GraphQL Schema definition
Require by
- AccessInfoAccess information for a given resource
@beta
- AccessInfoList@beta
- AddressAn internationalized Address.
The amount of data available depends on what has been
set. Use `status` to determine how much of the
address should be populated.
- 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.
- AssetBundleA bundle or group of assets associated with the model.
This interface will only be applied to objects which also
implement Asset.
If a `url` is specified it will be to a compressed file containing
all the associated assets.
If `urlTemplate` is specified there will be additional details on the implementing
class describing how to interpolate the template to get the associated urls.
- BundleProcessingInformationCurrent information about the processing of a bundle purchase.
- ClipA video clip
- CommentMarkdown text and/or attachments made on an annotation.
- CommentDetailsundefined
- CommentPatchundefined
- CommentResultListPaged list of comments.
- CommonAssetA binary asset associated with the model.
- ExternalAttachmentDetailsundefined
- FloorPatchA patch operation on a floor, updates the
specified fields, leaving the others unchanged.
To clear a String field, use the empty string ("").
- FloorplanA floorplan, often formatted as an image, although other
options may be available.
- Folderundefined
- FolderAccessQueryundefined
- FolderDetailsundefined
- FolderPatchundefined
- FolderShareAccessLevelundefined
- GeoLocationundefined
- GeoPointundefined
- HighlightReelAn ordered list of assets, typically pictures, highlighting features of the model.
- Imageundefined
- InferenceEvent@beta This field is part of a limited access beta.
- KeyValueA generic mapping of key-value pairs. This is used to model
map and dynamic nested structures which aren't directly
supported by GraphQL but can be useful at times.
- KeyValueInputundefined
- 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.
- MeasurementPathDetailsundefined
- MeasurementPathPatchundefined
- MeshA 3D geometry of the model.
- MlsDetailsPatchA patch operation on the real estate listing details of the model, updates the
specified fields, leaving the others unchanged.
- 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.
- ModelAssetsPatchundefined
- ModelBundleA set of assets or features associated with a model that may be unlocked.
- ModelContactContact information to be published when making a model public.
- ModelContactPatchA patch operation on the model contact details.
Updates the specified fields, leaving the others unchanged.
- ModelEventWebhookCallbackListA page of model event webhook callbacks. In order to access the next page,
call `modelEventWebhookCallbacks` again with all parameters the same except passing in `nextOffset`
for `offset`.
- ModelFloorRepresents a floor within the model. This is generally used as a navigation helper as well as a container for rooms,
locations and annotations.
- ModelLayerA layer within a model, this contains a slice of model data
about the model or mask out information from lower layers.
One layer is below another if the `position` is smaller. A position
of 0 is always the bottom layer.
- 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 ("").
- ModelProcessingDetailsProgress information about model processing.
- ModelPublicationDetailsInformation related to displaying public model information.
- ModelRoomA room within the model, this acts as a container
for other information.
- ModelSearchLocationsSearch summary information about all the anchor locations within a model.
- ModelSearchMattertagsSearch summary information about all the mattertags in the model.
- ModelSearchMeasurementsSearch summary information about all the measurements in the model.
- ModelSearchMeshesSearch summary information about all the 3D meshes associated with the model.
- ModelSearchPanosSearch summary information about all the panoramic images in the model.
- ModelSearchPublicationDetailsSearch summary information related to the public model 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.
- ModelSearchResultListA page of models matching the specified query. In order to access the next page,
call `models` again with all parameters the same except passing in `nextOffset`
for `offset`.
- ModelSearchRoomsSearch summary information about all the rooms in the model.
- ModelSearchTexturesSearch summary information about all the textures associated with the model.
- 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
- ObjectAccessResultsListA paged list of object access details
- ObjectAnnotation@beta This field is part of a limited access beta.
- ObjectClassification@beta This field is part of a limited access beta.
- OrganizationMetadataConcrete OrganizationSummary for representing metadata.
- OrganizationSummaryBasic metadata about an organization.
- PagedFolderListundefined
- PagedModelListundefined
- PanoramicImageA 360 degree panoramic image.
- PanoramicImageLocationundefined
- PanoramicImageOptionA set of resolutions that are available for
a given format.
- 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
- PublicationDetailsPatchA patch operation on the public viewer details.
Updates the specified fields, leaving the others unchanged.
- QueryData fetch operations.
- Resourceundefined
- RoleSummarySummary for Role
- RoomClassification@beta This is part of the Property Insights Beta
- RoomDetails@beta This is part of the Property Insights Beta
Used to create and patch model rooms.
- ShareableBasic details of a shared object
- ShareableFolderSummaryBasic details of a shared folder
- ShareableModelSummaryBasic details of a shared model
- ShareableObjectAn object that is able to be shared
- SharedWithThe entity (user or user group) an object was shared with
- 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.
- UserAccessResultsListA paged list of user access details
- UserFolderShareAccessundefined
- UserGroupSummaryA user group to which many users can belong.
Can have permission sets assigned to it.
Can have access and permission sets applied to individual models and folders (and their contents).
- UserMetadataConcrete UserSummary for representing metadata.
- UserSummaryBasic metadata about a user.
- WebhookCallbackThis data is the limited set of publicly accessible information for a callback.
- WebhookCallbackInputSpecifies the callback details for the input
- WebhookCallbackPatchInputSpecifies the callback details for the patch input
- __Directiveundefined
- __EnumValueundefined
- __Fieldundefined
- __InputValueundefined
- __SchemaA GraphQL Introspection defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, the entry points for query, mutation, and subscription operations.
- __Typeundefined