Request

Response

    Autodesk.DataExchange assembly

    Autodesk.DataExchange namespace

    public typedescription
    enum BrepOutputFormat Format to output brep geometry in.
    class Client This component grants access to the Data Exchange functionality, offering methods for retrieving and updating both data and metadata associated with Data Exchanges.
    class Error Details and information about an error that has occurred.
    [Flags] enum GeometryFilters Filters to specify what type of geometries to process and return from the specified elements.
    class GeometryOutputOptions Options for geometry output.
    class HubIdRegion Represents a Hub ID and its associated region.
    enum MeshOutputFormat Format to output mesh geometry in.
    class SDKOptions It will provide a option to DataExchange SDK such as Authentication, Storage, Hosting, logger etc.
    class SDKOptionsDefaultSetup The SDKOptionsDefaultSetup class that contains default configuration for SDK Options, if not specfied.

    Autodesk.DataExchange.ADPAnalytics namespace

    public typedescription
    static class AdpAnalyticsServiceCollectionExtensions Registers a connector-supplied IAdpAnalytics implementation. Lives in the SDK assembly so the extension binds to ILRepack-internalized IServiceCollection types exposed by ConfigureServices.

    Autodesk.DataExchange.Authentication namespace

    public typedescription
    class Auth
    class AuthOptions Authentication Options. The combination of [ClientId and Port] or [ClientId, Secret and CallBack] is mandatory.
    class UserInfo The User Info class.

    Autodesk.DataExchange.ContractProvider namespace

    public typedescription
    class BimDexContractProvider BimDex contract with visualization support.
    class ContractProvider Default contract.

    Autodesk.DataExchange.Core namespace

    public typedescription
    class DeleteExchangeSuppressUIArgs This class contains arguments that can be specified to suppress UI prompts when Delete Exchange is called.
    class ExchangeItem The Data Exchange class is a container for basic information about data exchanges.
    abstract class Notifiable The Notifiable class is an abstract class that provides a mechanism for notifying changes properties to user interface.
    abstract class SuppressUIArgs It serves as a common base for classes that provide arguments for suppressing certain UI prompts.
    static class TaskExtensions Extension methods for safe fire-and-forget task execution. Use only when fire-and-forget is intentional and the caller genuinely cannot await the result.

    Autodesk.DataExchange.Core.Enums namespace

    public typedescription
    enum AuthGrantType The user authentication type Enum.
    enum ContractType The type of contract of the exchange.
    [Flags] enum ElementModifications The modifications that can be made to an element.
    enum ExecutionOrder Execution Order.
    enum GeometryFormat The format of the underlying geometry data.
    enum LogLevel Specifies the meaning and relative importance of a log event.
    enum NotificationType Pop up notifications types.
    enum ProjectType Hosting provider project types.
    enum SkippedElementType Enumeration for the types of skipped elements.
    enum STEPProtocol STEP Protocol values.

    Autodesk.DataExchange.Core.Events namespace

    public typedescription
    class AfterCreateExchangeEventArgs Event arguments for AfterCreateExchange event.
    class AfterGetExchangesEventArgs Event Arguments for After Get Exchanges Event.
    class AfterGetLatestExchangeDetailsEventArgs Event Arguments for After Get Latest Exchange Details Event.
    class AfterViewExchangeEventArgs Event Arguments class for AfterViewExchange event.
    class BeforeCreateExchangeEventArgs Event Arguments for Before Create Exchange Event.
    class BeforeGetExchangesEventArgs Event Arguements class for BeforeGetExchanges event.
    class BeforeViewExchangeEventArgs Event Arguments for BeforeViewExchange event.
    class ExchangesLoadedEventArgs Event arguments for exchanges loaded event.
    class ExchangesModifiedEventArgs Class that defines updated exchanges in case of exchange update event.
    class ExchangeUpdatedEventArgs Class object to define data associated with Exchange updated event.
    class GetLatestExchangeDetailsEventArgs Event Arguments for GetLatestExchangeDetails event.

    Autodesk.DataExchange.Core.Interface namespace

    public typedescription
    interface IAuth Defines an interface for managing authentication within the connector kit.
    interface IConnectorAPI The IConnectorAPI class provides a UI-related functionalities such as exchange create, update, delete, etc.
    interface IContractProvider An interface for data exchange contract provider.
    interface IDataExchange This interface represents the contract for the Data Exchange. It defines the set of public members and methods that must be implemented by any class that aims to provide the functionality of the Data Exchange.
    interface IDataExchangeIdentifier This interface represents the contract for the Data Exchange Identifier. It defines the set of public members and methods that must be implemented by any class that aims to provide the functionality of the Data Exchange Identifier.
    interface IEventsController
    interface IExchange Interface that needs to be implemented by clients.
    interface IExchangeInput This interface represents the contract for the IExchangeInput. It defines the set of public members and methods that must be implemented by any class that aims to provide the functionality of the IExchangeInput.
    interface IExchangeItem This interface represents the contract for the Autodesk.DataExchange It defines the set of public members and methods that must be implemented by any class that aims to provide the functionality of the Autodesk.DataExchange.OpenAPI.
    interface IExchangeReader An interface to read exchange related operations.
    interface IExchangeSearchFilter This interface represents the contract for the Exchange Search Filter. It defines the set of public members and methods that must be implemented by any class that aims to provide the functionality of the Exchange Search Filter.
    interface IExchangeWriter An interface to write exchange related operations.
    interface IFeatureFlagController Provides methods to interact with our FeatureFlagManager.
    interface IFolderDetails This interface represents the contract for the FolderDetails. It defines the set of public members and methods that must be implemented by any class that aims to provide the functionality of the FolderDetails.
    interface IFolderInfo This interface represents the contract for the FolderInfo. It defines the set of public members and methods that must be implemented by any class that aims to provide the functionality of the FolderInfo.
    interface IHostingProvider The Hosting provider.
    interface IHubInfo This interface represents the contract for the Hub Information.
    interface ILogger An interface for logging.
    interface IProjectInfo This interface represents the contract for the Project Information.
    interface ISourceProvider The source provider for Data exchange.
    interface IStorage An interface for data-cache.
    interface IUserAccount This interface represents the contract for the User Account. It defines the set of public members and methods that must be implemented by any class that aims to provide the functionality of the User Account.

    Autodesk.DataExchange.Core.Models namespace

    public typedescription
    enum ApplicationMode Application Mode of operation.
    class DataExchange Class object to define Exchange properties.
    class DataExchangeIdentifier The class represents an identifier for data exchange.
    class DeletedFolders Class to provide information about Deleted Folders.
    class ExchangeFilterResult Class for Exchange Filter Result.
    class ExchangeInput Exchange input class.
    class ExchangeItemAttributes Exchange item attributes.
    class ExchangeItemMetadata Exchange item meta data.
    class ExchangeMetadata Container class for ExchangeItem Meta data.
    class ExchangeMetadataDescriptor Represents a descriptor for exchange metadata operations, including status information.
    class ExchangeSearchFilter Exchange Search filter.
    class ExchangeUpdatedEventData Class object to define data associated with Exchange updated event.
    class FolderDetails Folder Details.
    class FolderInfo Folder Info class.
    class HubInfo Hub Information.
    class Included API Response object.
    class Lookup<T> Class that contains id and description properties that can be used to bind to drop downs.
    class NotificationInfo Represents a notification message to be displayed in the Connector UI.
    class ProjectInfo Forma (formerly ACC) Project information class.
    class UserAccount User Account class.
    class ValidationStatus Represents the validation status of a data exchange.

    Autodesk.DataExchange.DataModels namespace

    public typedescription
    class Element Provides a Revit Element wrapper over an InstanceAsset object.
    class ElementDataModel Provides a data-model friendly wrapper over the exchange data for easier access to the data.
    abstract class ElementGeometry Class for element geometry (STEP,Mesh, OBJ, etc.)
    class FileGeometry Provides access to the Geometry. Implements IDisposable to clean up temporary files created from streams.
    class MeshGeometry Represents an in-memory mesh geometry.
    class Parameter Represents a Parameter.
    class ParameterDataType Represents a parameter data type that can hold one of the following types: string, long, double, or bool.
    class ParameterSchemaId Represents a unique identifier for a parameter schema.
    class ParameterSet List of parameters is a parameter set.
    class PrimitiveGeometry Primitive Geometry (Line, Curve, Point, etc.).
    class RenderStyle This class is used to represent the RenderStyle.
    class RGBA Represent the elements color in RGB format.
    class StreamGeometry Represents geometry data as an in-memory stream. Use extension methods like ElementGeometry.AsStreamGeometryAsync() to convert file-based geometry to stream. The caller is responsible for disposing the stream when done.
    class Units Represents the units for geometry.

    Autodesk.DataExchange.Exceptions namespace

    public typedescription
    class AllCallbackPortsInUseException Exception thrown when every configured OAuth callback URL fails to bind on the local HTTP listener. Each individual failure can be a port-in-use socket conflict (ErrorCode 32), an http.sys URL ACL reservation for another account (ErrorCode 183 or 5), or any other listener-binding error. The error from the final URL attempted is preserved on InnerException when available.
    class ApiException<TResult> ApiException with TResult.
    class ApiException Api exception.
    class DataSyncException
    class ExchangeAlreadyDeletedException Represents an error that occurs when an operation is attempted on an exchange that has already been deleted.
    class ExchangeOperationException Represents an error that occurs during an exchange operation (create, load, update, delete). Used by UI handlers to wrap lower-level exceptions with user-facing messages.
    class GeneralException General exception for all Design Translator SDK specific errors.
    class GeometryDownloadException
    class GeometryTranslationException Exception class used to throw/rethrow GUSDK related exceptions.
    class GeometryUploadException
    class HTTPResponseException HTTP response exception.
    class IntermediateGeometryConversionException Class to throw exceptions related to conversion of binary data to intermediate geometry(smb/ttmesh).
    class InvalidAssetStateTransitionException
    class InvalidExchangeTitleException This exception is thrown when the exchange title is invalid.
    class InvalidMessageTypeException Represents an error that occurs when a message handler receives an unexpected or invalid message type.
    class JSONSerializeException Exception for JSON serialization errors.
    class NotFoundException Not found exception.
    class ParameterRegistrationException
    class PermissionDeniedException Represents an error that occurs when the user does not have sufficient permissions to perform the requested operation.
    class PortInUseException Exception thrown when the configured OAuth callback URL cannot be bound by the local HTTP listener. Causes include the underlying socket being in use (ErrorCode 32), an http.sys URL ACL reservation for a different account (ErrorCode 183 or 5), or other listener-binding failures. The original failure is preserved on InnerException when available.
    class TranslationException Exception for errors that occur during translation execution.
    class UnsupportedException Unsupported exception.
    enum ValidationContext Defines the validation context for exchange operations.
    class ValidationException Exception for errors that occur in input validation.
    class ValidationFailedException Represents an exception that is thrown when validation fails during exchange operations. This exception is thrown when !:IExchange.ValidateCanCreateExchangeAsync or !:IExchange.ValidateCanUpdateExchangeAsync implementation in connector returns a non-empty collection of validation error strings. UI relies on this exception to display the corresponding error notification toast instead of showing the default error notification.

    Autodesk.DataExchange.Exceptions.Enums namespace

    public typedescription
    enum ApiErrorCodes The ApiErrorCodes Enum.

    Autodesk.DataExchange.Extensions namespace

    public typedescription
    static class GeometryConversionExtensions Extension methods for converting between StreamGeometry and FileGeometry. Provides fluent API for stream-to-file and file-to-stream conversions. Note: MeshGeometry is a separate type and does not participate in these conversions. If geometry is inherently a MeshGeometry, it will be returned as such from the SDK.

    Autodesk.DataExchange.Extensions.HostingProvider namespace

    public typedescription
    class ACC This class provides functionalities for accessing Hubs, Projects, Folders, and many more within Forma (formerly Autodesk Construction Cloud) using API. The ACC class facilitates the connection to Forma (formerly ACC) APIs.

    Autodesk.DataExchange.Extensions.Logging.File namespace

    public typedescription
    class Log Logging class. Writes log on the basis of level defined in configuration.

    Autodesk.DataExchange.Extensions.Storage.File namespace

    public typedescription
    class Storage File based cache.

    Autodesk.DataExchange.Insights namespace

    public typedescription
    class CounterMetric Metric for a single counter (e.g. asset count, payload bytes).
    static class Metrics Metric class to track performance metrics.
    class OperationMetric Metric for a single operation.
    class PerformanceMetricReport

    Autodesk.DataExchange.Interface namespace

    public typedescription
    struct ClassificationSystem Identifies a classification system (Category, Family, Layer, ...) used when tagging elements via Classify. Ships with a set of well-known values for common systems; use Custom for host-specific or industry-specific taxonomies not represented as well-known. Comparison is case-insensitive.
    interface IClassification Read view of a classification node. Hierarchy is walked via Parent (flat-leaf-with-parent, spec D-18 option A).
    interface IClient The IClient interface represents the contract for the Autodesk.DataExchange. It defines the set of public members and methods that must be implemented by any class that aims to provide the functionality of the Autodesk.DataExchange.OpenAPI. The specific methods and members defined within the IClient interface may vary based on the requirements and capabilities of the Autodesk.DataExchange implementation. They typically include operations for data retrieval, data update, metadata management, error handling, and other relevant functionalities related to Data Exchanges.
    interface IDesign A read-only reference to the Design that represents the geometry and the model hierarchy associated with an element.
    interface IElement This interface is used to define an element.
    interface IElementDataModel This interface is used to define an element data model.
    interface IElementGeometry This interface is used to define an element geometry.
    interface IElementType A specialization of IClassification for type-level classification nodes. Carries type-level parameters in addition to the standard classification data.
    interface IExchangeDetails This interface is used to define the exchange details.
    interface IExchangeRevision This interface is used to define an exchange revision.
    interface IFileGeometry This interface is used to define a File Based geometry.
    interface IParameter This interface is used to define a parameter.
    interface IPrimitiveGeometry This interface is used to define a primitive geometry.
    interface IRenderStyle This interface is used to define a render style.

    Autodesk.DataExchange.Models namespace

    public typedescription
    class ExchangeCreateRequestACC This class represents a request for creating an exchange on Forma (formerly ACC) and accepts the essential details of the data exchange and any host provider specific parameters that are required by Forma.
    abstract class ExchangeCreateRequestBase This class represents a request for creating an exchange and accepts the essential details of the data exchange.
    class ExchangeDetails Class to define ExchangeDetails. It will contain all the basic necessary detail about the data exchange such as Exchange Id, Project, etc.
    class ExchangeRevision Provides meta-data about a Data Exchange Revision such as date and time.
    class GeometryConfiguration The Geometry configuration class where you can configure GUSDK configuration such as STEPProtocol, STEPTolerance, etc.
    interface IError Interface definition of a reason.
    interface IReason Definition of a reason.
    interface IRequest<TParameters> Represents a request with specific parameters.
    interface IRequestParameters Represents the contract for request parameters in the Autodesk Data Exchange.
    interface IResponse<TValue> Definition of a result with a value of type TValue.
    interface IResponseBase Interface defination of a response.
    interface ISuccess Represents a successful response.
    class Request<TParameters> Generic request object.
    abstract class RequestParametersBase Represents the base class for request parameters.
    class ViewableWorldCoordinates World Coordinates for exchange viewable. The default value for UP is X = 0.0F, Y = 0.0F, Z = 1.0F The default value for Front is X = 0.0F, Y = -1.0F, Z = 0.0F The default value for North is X = 0.0F, Y = 1.0F, Z = 0.0F.

    Autodesk.DataExchange.Models.Components namespace

    public typedescription
    class Transformation Represents a transformation in 4D.

    Autodesk.DataExchange.Models.Math namespace

    public typedescription
    class Matrix4d Represents a 4x4 matrix for transformations.

    Autodesk.DataExchange.OpenAPI namespace

    public typedescription
    class ApiException<TResult>
    class ApiException
    class AssetResponse The requested assets
    enum AssetResponseOperation
    class AttributeEntityResponse All attributes associated with this exchange
    class AttributeRequest The list of attributes
    enum AttributeRequestOperation
    class AttributeResponse
    class AuditEntity The information on the user or service that last modified the entity.
    class BinaryDownloadBatchRequest
    class BinaryDownloadBatchResponse
    class BinaryDownloadRequestItem List of binary download requests
    class BinaryDownloadResponseItem List of binaries with download details
    class BinaryUploadFinishRequest
    class BinaryUploadFinishRequestItem List of binaries for which the upload has completed
    class BinaryUploadFinishResponse
    class BinaryUploadFinishResponseItem List of binaries for which upload is finished and updated in the database
    class BinaryUploadRequest
    class BinaryUploadRequestItem A list of binary assets to be created.
    enum BinaryUploadRequestItemType
    class BinaryUploadResponse
    class BinaryUploadResponseItem List of binaries that are newly created or revisioned
    class ChangeSet The set of permission changes
    class CollectionResponse
    class ComponentEntityResponse All components associated with this exchange
    class ComponentsChangeSet See HFDM Schema Specification 1.0 - Change Sets
    class CreateCollectionRequest
    class CreateExchangeRequest
    enum CreateExchangeRequestType
    class Entity
    class Error Details and information about an error that has occurred
    class ErrorResponse
    class FileResponse
    class Filter
    class FulfillmentRequest
    enum FulfillmentRequestExecutionOrder
    class FulfillmentResponse
    class FulfillmentSyncRequest
    class GetAssetsClosureRequest
    class GetAssetsClosureResponse
    class GetBulkAssetsRequest
    class GetBulkAssetsResponse
    class Includes
    class JsonNode
    class L2csCollectionResponse Collection where the exchange is stored
    class OneOfEntry
    class PaginatedAssetResponse
    class PaginatedParameterResponse
    class PaginatedRelationshipResponse
    class PaginatedRevisionResponse
    class PaginatedSpaceResponse
    class PaginatedSyncUrlResponse
    class Pagination The information on the pagination of the response
    class ParameterResponse The paginated results
    class ParametersCollectionResponse
    class PropertySetSchema
    class Relation
    class RelationshipFilter
    enum RelationshipFilterDirection
    class RelationshipResponse All the relationships that are referred to in the topology at their respective tip (latest) version
    enum RelationshipResponseOperation
    class RemoveRelationshipImplicitRequest
    class RevisionResponse The paginated results
    class SchemaProperty
    enum SchemaPropertyContext
    class SnapshotResponse
    class SpaceResponse
    class SplitTypeId
    class StartAsset Only accepts a single asset.
    class SyncAssetRequest Assets to be uploaded into the fulfillment
    class SyncCreateAssetRequest
    class SyncCreateRelationshipRequest
    class SyncRelationshipRequest Relationships to be uploaded into the fulfillment
    class SyncRemoveAssetRequest
    class SyncRemoveRelationshipRequest
    class SyncSchemaRequest Schemas to be uploaded into the fulfillment
    class SyncUpdateAssetRequest
    class SyncUpdateRelationshipRequest
    class SyncUrlResponse The paginated results
    class Topology Graph of all the relationships and assets that were computed by the closure query
    class TopologyEdge A list of graph edges associated with a relationship
    class TopologyNode A list of graph nodes associated with an asset
    enum TopologyNodeExcluded
    class TypedRelation The ending asset and snapshot of the relationship
    class ValidationError List of validation errors

    Autodesk.DataExchange.ProgressManager namespace

    public typedescription
    class DefaultProgressStepProvider Default implementation of progress step definitions provider. Provides predefined step definitions for Create, Load, Update, and LoadLatest operations.
    class ProgressStepsManager Manages progress steps for different types of operations in the Data Exchange workflow. This implementation provides thread-safe progress tracking with dependency injection support.

    Autodesk.DataExchange.ProgressManager.Enums namespace

    public typedescription
    enum Operation
    static class ProgressStepId

    Autodesk.DataExchange.ProgressManager.Interfaces namespace

    public typedescription
    interface IProgressStep Represents a single progress step in an operation. This interface provides properties and methods to manage the progress and display information of a step.
    interface IProgressStepFactory Factory interface for creating progress steps.
    interface IProgressStepProvider Provides progress step definitions for different operations.
    interface IProgressStepsManager Manages progress steps for different types of operations in the Data Exchange workflow. This interface provides functionality to register, retrieve, and manage progress steps that are used to track and report progress during long-running operations such as exchange creation, loading, and updating.
    interface IProgressUpdateListener
    class ProgressStepDefinition Represents a progress step definition.

    Autodesk.DataExchange.ProgressManager.Utilities namespace

    public typedescription
    static class EnumExtensions Provides extension methods for working with enum values and their DescriptionAttribute decorations.

    Autodesk.DataExchange.Resiliency namespace

    public typedescription
    class CustomHttpClient Custom Http Client.
    interface IRetryPolicyConfig Configuration interface for retry policies.
    class RetryPolicyConfig Default implementation of retry policy configuration.

    Autodesk.DataExchange.Resources namespace

    public typedescription
    class ConnectorResHelper

    Autodesk.DataExchange.SchemaObjects.Units namespace

    public typedescription
    class Unit A definite magnitude used as a standard of measurement http://docs.adskunits.apiary.io/#introduction/definitions/measurement-units autodesk.unit:unit-1.0.0 Use Autodesk.DataExchange.SchemaObjects.Units.UnitFactory for Unit initialization.
    static class UnitFactory UnitFactory is used for Unit initialization.
    enum UnitSystem Systems of measurement units. autodesk.unit:system-1.0.0.

    Autodesk.DataExchange.Schemas namespace

    public typedescription
    class HttpClientWrapper

    Autodesk.DataExchange.Schemas.Interface namespace

    public typedescription
    interface IHttpClientWrapper Interface for HTTP operations.

    Autodesk.DataExchange.Schemas.Models namespace

    public typedescription
    class Annotation
    class Attributes
    class BatchGetSchemaPayload Represents a payload for batch getting schema information.
    class Constant
    class Data
    class Links
    class ParameterPayload Request body/payload to create a parameter by parameter service
    class Property1
    class Relationships
    class Schema
    class SchemaObject
    class Typedvalue

    Autodesk.DataExchange.SourceProvider namespace

    public typedescription
    class SourceProvider Default source provider(Null provider).

    Autodesk.Parameters namespace

    public typedescription
    static class EnumExtensions Enum extension is used to get enum description as DisplayName.
    enum Group A parameter group is a group of collections united by the same purpose.
    enum Spec A spec describes a data type for user-facing presentation. For example, to specify a custom property in a design app, the end user may select a data type for the property. The app may present a list of available data types, such as Text, Yes/No, Image, Length, or Thermal Resistance, each of which corresponds to a spec object.