Request

Response

    Reference Guide

    TypeScript SDK Reference

    Resource Information

    Package Name:
    @aps_sdk/model-derivative
    Version:
    1.0.0

    Installing this Library

    npm i @aps_sdk/model-derivative
    

    Learning Resources

    Source Code

    The source code for this library is available at https://github.com/autodesk-platform-services/aps-sdk-node.

    Tutorials

    The Simple Viewer tutorial on the https://tutorials.autodesk.io/ site illustrates how to use this library to prepare a model for display in a browser.

    Code Sample

    import { ModelDerivativeClient, JobPayload, OutputType, View } from "@aps_sdk/model-derivative";
    
    // Access token for authentication
    const ACCESS_TOKEN = "...";
    // Unique Resource Name (URN) for the model to be translated
    const MODEL_URN = "...";
    
    // Initialize the Model Derivative Client
    const modelDerivativeClient = new ModelDerivativeClient();
    
    // Define the job payload with input URN and output formats
    const payload: JobPayload = {
        input: {
            urn: MODEL_URN, // URN of the model to be translated
            compressedUrn: false // Indicates that the model is not compressed
        },
        output: {
            formats: [{
                type: OutputType.Svf2, // Output format set to SVF2
                views: [View._2d, View._3d] // Include both 2D and 3D views in the output
            }, {
                type: OutputType.Thumbnail // Output format set to Thumbnail
            }],
        }
    };
    
    // Start the translation job with the specified payload and access token
    const job = await modelDerivativeClient.startJob(payload, { accessToken: ACCESS_TOKEN });
    
    // Log the job result to the console
    console.log(job);
    
    Show More

    See https://github.com/autodesk-platform-services/aps-sdk-node/blob/main/samples/modelderivative.ts for a complete code sample.

    SDK to REST API Cross Reference

    Operation CategoryOperationMethodHTTP Request

    Derivatives

    Fetch Derivative Download URL getDerivativeUrl GET /{urn}/manifest/{derivativeUrn}/signedcookies
    Check Derivative Details headCheckDerivative HEAD /{urn}/manifest/{derivativeUrn}
    Informational List Supported Formats getFormats GET /formats

    Jobs

    Create Translation Job startJob POST /job
    Specify References specifyReferences POST /{urn}/references

    Manifest

    Fetch Manifest getManifest GET /{urn}/manifest
    Delete Manifest deleteManifest DELETE /{urn}/manifest

    Metadata

    List Model Views getModelViews GET /{urn}/metadata
    Fetch Object Tree getObjectTree GET /{urn}/metadata/{modelGuid}
    Fetch All Properties getAllProperties GET /{urn}/metadata/{modelGuid}/properties
    Fetch Specific Properties fetchSpecificProperties POST /{urn}/metadata/{modelGuid}/properties:query
    Thumbnails Fetch Thumbnail getThumbnail GET /{urn}/thumbnail
     
    ______
    icon-svg-close-thick

    Cookie preferences

    Your privacy is important to us and so is an optimal experience. To help us customize information and build applications, we collect data about your use of this site.

    May we collect and use your data?

    Learn more about the Third Party Services we use and our Privacy Statement.

    Strictly necessary – required for our site to work and to provide services to you

    These cookies allow us to record your preferences or login information, respond to your requests or fulfill items in your shopping cart.

    Improve your experience – allows us to show you what is relevant to you

    These cookies enable us to provide enhanced functionality and personalization. They may be set by us or by third party providers whose services we use to deliver information and experiences tailored to you. If you do not allow these cookies, some or all of these services may not be available for you.

    Customize your advertising – permits us to offer targeted advertising to you

    These cookies collect data about you based on your activities and interests in order to show you relevant ads and to track effectiveness. By collecting this data, the ads you see will be more tailored to your interests. If you do not allow these cookies, you will experience less targeted advertising.

    icon-svg-close-thick

    THIRD PARTY SERVICES

    Learn more about the Third-Party Services we use in each category, and how we use the data we collect from you online.

    icon-svg-hide-thick

    icon-svg-show-thick

    Strictly necessary – required for our site to work and to provide services to you

    Qualtrics
    W
    Akamai mPulse
    W
    Digital River
    W
    Dynatrace
    W
    Khoros
    W
    Launch Darkly
    W
    New Relic
    W
    Salesforce Live Agent
    W
    Wistia
    W
    Tealium
    W
    Upsellit
    W
    CJ Affiliates
    W
    Commission Factory
    W
    Google Analytics (Strictly Necessary)
    W
    Typepad Stats
    W
    Geo Targetly
    W
    SpeedCurve
    W
    Qualified
    #

    icon-svg-hide-thick

    icon-svg-show-thick

    Improve your experience – allows us to show you what is relevant to you

    Google Optimize
    W
    ClickTale
    W
    OneSignal
    W
    Optimizely
    W
    Amplitude
    W
    Snowplow
    W
    UserVoice
    W
    Clearbit
    #
    YouTube
    #

    icon-svg-hide-thick

    icon-svg-show-thick

    Customize your advertising – permits us to offer targeted advertising to you

    Adobe Analytics
    W
    Google Analytics (Web Analytics)
    W
    AdWords
    W
    Marketo
    W
    Doubleclick
    W
    HubSpot
    W
    Twitter
    W
    Facebook
    W
    LinkedIn
    W
    Yahoo! Japan
    W
    Naver
    W
    Quantcast
    W
    Call Tracking
    W
    Wunderkind
    W
    ADC Media
    W
    AgrantSEM
    W
    Bidtellect
    W
    Bing
    W
    G2Crowd
    W
    NMPI Display
    W
    VK
    W
    Adobe Target
    W
    Google Analytics (Advertising)
    W
    Trendkite
    W
    Hotjar
    W
    6 Sense
    W
    Terminus
    W
    StackAdapt
    W
    The Trade Desk
    W
    RollWorks
    W

    Are you sure you want a less customized experience?

    We can access your data only if you select "yes" for the categories on the previous screen. This lets us tailor our marketing so that it's more relevant for you. You can change your settings at any time by visiting our privacy statement

    Your experience. Your choice.

    We care about your privacy. The data we collect helps us understand how you use our products, what information you might be interested in, and what we can improve to make your engagement with Autodesk more rewarding.

    May we collect and use your data to tailor your experience?

    Explore the benefits of a customized experience by managing your privacy settings for this site or visit our Privacy Statement to learn more about your options.