Changelog
This section documents the changes made to the Data Exchange GraphQL API.
Release Date: 2025-01-07
Following are the changes made in this release:
Added
- Added the createExchange mutation, which allows you to create data exchanges. For instructions, refer to the Create Exchanges Using Mutations guide.
- Added the getExchangeCreationStatus query to retrieve the status of a data exchange after creation.
- New fields
isReadOnly
,isHidden
,isArchived
, andvalueType
are added to the propertyDefinition object. - A new field
region
is added to the Hub object, which can be used to retrieve the region of the Hub.
Updated
- You can now fetch items and exchanges from a folder using the folder query. Previously only exchanges could be retrieved from a folder.
Earlier version:
query GetFolder($folderId: ID!) { folder(folderId: $folderId) { id name exchanges { results { id name alternativeRepresentations { fileUrn } } } } }
Show MoreUpdated version:
query GetFolder($folderId: ID!) { folder(folderId: $folderId) { id name exchanges { results { id name alternativeRepresentations { fileUrn } } } items { ... on Items { results { id name extensionType } } } } }
Show MoreNote: An Item could be either IFC or Revit file.
- The type of the
units
field in thePropertyDefinitions
object is changed fromString
to Object .Earlier version:
query GetPropertyDefinitionOfExchange($exchangeId: ID!) { exchange(exchangeId: $exchangeId) { id name propertyDefinitions { results { id name units } } } }
Show MoreUpdated version:
query GetPropertyDefinitionOfExchange($exchangeId: ID!) { exchange(exchangeId: $exchangeId) { id name propertyDefinitions { results { id name units { name } } } } }
Show More - The type of the
value
field in the Property object is changed fromPropertyData
toPropertyValue
.
Deprecated
Following are the queries, objects, and fields that have been deprecated in this release:
Deprecated Queries
Old Query | New Query |
---|---|
exchangeByFileId | exchangeByFileUrn |
Deprecated Objects
Old Object | New Object |
---|---|
Definition | PropertyDefinition |
ElementAlternativeRepresentations | ElementAlternativeIdentifiers |
ExchangeAlternativeRepresentations | ExchangeAlternativeIdentifiers |
Lineage | ExchangeVersionHistory |
ProjectAlternativeRepresentations | ProjectAlternativeIdentifiers |
Deprecated Fields
Old Field | New Field |
---|---|
lineage | versionHistory |
alternativeRepresentations | alternativeIdentifiers |
Release Date: 2024-05-08
Beta Updates
- We now support regionalization within our API through the use of regionalization headers for the US and EMEA regions. For more details, see GraphQL Endpoint.
Release Date: 2024-04-02
Beta Updates
- A task titled Retrieve Element Properties and Associated Reference Properties such as typeProperties has been added to explain the procedure of working with reference types.
Release Date: 2023-06-12
Public beta release.
Release Date: 2022-11-28
Private beta release.