Request

Response

    IClient interface

    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.

    public interface IClient
    

    Members

    namedescription
    ProgressStepsManager { get; } Gets the progress step manager for reporting exchange operation progress to the connector UI.
    CreateCollectionAsync(…) Creates a collection asynchronously.
    CreateExchangeAsync(…) Creates an exchange asynchronously.
    DeleteExchangeAsync(…) Deletes an exchange.
    DownloadCompleteExchangeAsIFC(…) Downloads the whole exchange as an IFC file.
    DownloadCompleteExchangeAsOBJ(…) Downloads the whole exchange as an OBJ file.
    DownloadCompleteExchangeAsSTEP(…) Downloads the whole exchange as a STEP file.
    DownloadCompleteExchangeAsUSD(…) Downloads the complete exchange data in USD format.
    GetCollectionIdAsync(…) Gets a collection using the project URN. The call is always region-routed; when hubId is supplied the region is resolved from the hub, otherwise from the project URN.
    GetElementDataModelAsync(…) Gets exchange data asynchronously. (3 methods)
    GetExchangeDetailsAsync(…) Gets exchange details by ID asynchronously. (2 methods)
    GetExchangeRevisionsAsync(…) Gets exchange revisions asynchronously.
    GetHubIdAsync(…) Gets the hub ID using the project URN.
    GetLatestExchangeVersionAsync(…) Gets exchange's latest file version asynchronously.
    RetrieveLatestExchangeAsync(…) Retrieves the latest exchange revision and updates the supplied elementDataModel.
    SyncExchangeDataAsync(…) Updates exchange data asynchronously.

    Remarks

    Methods return IResponse or !:IResponse. Check IsFailed before using the value — operational failures are returned, not thrown, unless documented otherwise on a specific member.

    See Also