Request

Response

    Reference Guide

    TypeScript SDK Reference for Data Management

    Resource Information

    Package Name:
    @aps_sdk/data-management
    Version:
    1.0.0

    Installing this Library

    npm i @aps_sdk/data-management
    

    Learning Resources

    Source Code

    The source code for this library is available at https://www.npmjs.com/package/@aps_sdk/data-management.

    Tutorials

    The ACC Administrator tutorial on the https://tutorials.autodesk.io/ site illustrates how to use this library to browse through hubs and projects.

    Code Sample

    import { Hubs } from "@aps_sdk/data-management";
    
    // Access token for authentication
    const ACCESS_TOKEN = "...";
    
    // Initialize the Data Management Client
    const dataManagementClient = new DataManagementClient();
    
    // Returns a collection of accessible hubs.
    const hubs = await dataManagementClient.getHubs({accessToken: ACCESS_TOKEN});
    
    // Log the details of the retrieved hubs to the console
    console.log(hubs);
    
    Show More

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


    SDK to REST API Cross Reference

    Operation CategoryOperationMethodHTTP Request

    Commands

    Check Permission executeCheckPermissionCommand POST /projects/{project_id}/commands
    Publish Model executeGetPublishModelJobCommand POST /projects/{project_id}/commands
    Publish Without Links executePublishWithoutLinksCommand POST /projects/{project_id}/commands
    Get Publish Model Job executePublishModelCommand POST /projects/{project_id}/commands
    List Refs executeListRefsCommand POST /projects/{project_id}/commands
    List Items executeListItemsCommand POST /projects/{project_id}/commands

    Hubs

    List Hubs getHubs GET /hubs
    Get a Hub getHub GET /hubs/{hub_id}

    Projects

    Get Projects getHubProjects GET /hubs/{hub_id}/projects
    Get a Project getProject GET /hubs/{hub_id}/projects/{project_id}
    Get Hub for Project getProjectHub GET /hubs/{hub_id}/projects/{project_id}/hub
    List Top-level Project Folders getProjectTopFolders GET /hubs/{hub_id}/projects/{project_id}/topFolders
    Create a Storage Location in OSS createStorage POST /projects/{project_id}/storage
    Get Download Details getDownload GET /projects/{project_id}/downloads/{download_id}
    Create Download createDownload POST /projects/{project_id}/downloads
    Check Download Creation Progress getDownloadJob GET /projects/{project_id}/jobs/{job_id}

    Folders

    Get a Folder getFolder GET /projects/{project_id}/folders/{folder_id}
    Modify a Folder patchFolder PATCH /projects/{project_id}/folders/{folder_id}
    Get Parent of a Folder getFolderParent GET /projects/{project_id}/folders/{folder_id}/parent
    List Folder Contents getFolderContents GET /projects/{project_id}/folders/{folder_id}/contents
    List Related Resources for a Folder getFolderRefs GET /projects/{project_id}/folders/{folder_id}/refs
    List Folder and Subfolder Contents getFolderSearch GET /projects/{project_id}/folders/{folder_id}/search
    List Custom Relationships for a Folder getFolderRelationshipsRefs GET /projects/{project_id}/folders/{folder_id}/relationships/refs
    Create a Custom Relationship for a Folder createFolderRelationshipsRef POST /projects/{project_id}/folders/{folder_id}/relationships/refs
    List Relationship Links for a Folder getFolderRelationshipsLinks GET /projects/{project_id}/folders/{folder_id}/relationships/links
    Create a Folder createFolder POST /projects/{project_id}/folders

    Items

    Get an Item getItem GET /projects/{project_id}/items/{item_id}
    Update an Item patchItem PATCH /projects/{project_id}/items/{item_id}
    Get Parent of an Item getItemParentFolder GET /projects/{project_id}/items/{item_id}/parent
    List Custom Relationships for an Item getItemRelationshipsRefs GET /projects/{project_id}/items/{item_id}/relationships/refs
    Create a Custom Relationship for an Item createItemRelationshipsRef POST /projects/{project_id}/items/{item_id}/relationships/refs
    List Related Resources for an Item getItemRefs GET /projects/{project_id}/items/{item_id}/refs
    List Relationship Links for an Item getItemRelationshipsLinks GET /projects/{project_id}/items/{item_id}/relationships/links
    Get Tip Version of an Item getItemTip GET /projects/{project_id}/items/{item_id}/tip
    List all Versions of an Item getItemVersions GET /projects/{project_id}/items/{item_id}/versions
    Create an Item createItem POST /projects/{project_id}/items

    Versions

    Get a Version getVersion GET /projects/{project_id}/versions/{version_id}
    Update a Version patchVersion PATCH /projects/{project_id}/versions/{version_id}
    Get Item by Version getVersionItem GET /projects/{project_id}/versions/{version_id}/item
    List Related Resources for a Version getVersionRefs GET /projects/{project_id}/versions/{version_id}/refs
    List Custom Relationships for a Version getVersionRelationshipsRefs LIST /projects/{project_id}/versions/{version_id}/relationships/refs
    Create Custom Relationship for a Version createVersionRelationshipsRef POST /projects/{project_id}/versions/{version_id}/relationships/refs
    List Links for a Version getVersionRelationshipsLinks GET /projects/{project_id}/versions/{version_id}/relationships/links
    Create a Version createVersion POST /projects/{project_id}/versions
    List Supported Download Formats getVersionDownloadFormats GET /projects/{project_id}/versions/{version_id}/downloadFormats
    List Available Download Formats getVersionDownloads GET /projects/{project_id}/versions/{version_id}/downloads