Module adeskForgeWrapper.datamgt

Module for the Data Management API

# ----------
# Wrapper for DATA MANAGEMENT API
# https://forge.autodesk.com/en/docs/data/v2/reference/http/
# ----------
'''Module for the Data Management API'''

import requests

from . import AFWExceptions
from .client import Client
from .client import Token
from .client import checkResponse
from .client import checkScopes

from .utils import AUTODESK_BASE_URL as BASE_URL

class Hub(object):
    _apiType = "hubs"
    def __init__(self, rawDict):
        self._raw = rawDict

    @property
    def apiType(self):
        return self._apiType
    @property
    def raw(self):
        return self._raw
    @property
    def type(self):
        return self._raw.get("type", None)
    @property
    def hub_id(self):
        return self._raw.get("id", None)
    @property
    def name(self):
        return self._raw["attributes"].get("name", None)
    @property
    def region(self):
        return self._raw["attributes"].get("region", None)

    @classmethod
    def hubById(cls, token, hub_id):
        '''Returns info on the hub give<br>
        Scope - data:read'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/project/v1/hubs/{hId}".format(hId=hub_id)
        r = requests.get(endpoint_url, headers=token.get_header).json()
        checkResponse(r)
        return cls(r)

    @classmethod
    def get_hubs(cls, token):
        '''Returns a collection of accessible hubs for this member.<br>
        Scope - data:read<br><br>
        
        Hubs represent BIM 360 Team hubs, Fusion Team hubs 
        (formerly known as A360 Team hubs),
        A360 Personal hubs, or BIM 360 Docs accounts.<br>
        Team hubs include BIM 360 Team hubs and Fusion Team hubs 
        (formerly known as A360 Team hubs). Personal hubs include A360 Personal hubs.'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/project/v1/hubs"
        r = requests.get(endpoint_url, headers=token.get_header).json()
        checkResponse(r)
        return [cls(h) for h in r["data"]]

    def get_projects(self, token):
        '''Returns a list of all projects in the hub<br>
        Scope - data:read'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/project/v1/hubs/{hId}/projects".format(hId=self.hub_id)
        projects = requests.get(endpoint_url,headers=token.get_header).json()
        checkResponse(projects)
        return [Project(p) for p in projects["data"]]

    def project_by_id(self, token, projectId):
        '''Returns a specific project by id
        Scope data:read'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/project/v1/hubs/{hId}/projects/{pId}".format(
            hId=self.hub_id, pId=projectId)
        r = requests.get(endpoint_url, headers=token.get_header).json()
        checkResponse(r)
        return Project(r["data"])

class Project(object):
    _apiType = "projects"
    def __init__(self, rawDict):
        '''TODO'''
        self._raw = rawDict

    @property
    def id(self):
        return self._raw.get("id", None)
    @property
    def raw(self):
        return self._raw
    @property
    def apiType(self):
        return self._apiType
    @property
    def name(self):
        return self._raw["attributes"].get("name", None)
    @property
    def hub_id(self):
        return self._raw["relationships"]["hub"]["data"].get("id", None)

    @classmethod
    def project_by_id(cls, token, hub_id , pId):
        '''Returns a specific project by id
        Scope data:read'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/project/v1/hubs/{hId}/projects/{pId}".format(
            hId=hub_id, pId=pId)

        r = requests.get(endpoint_url, headers=token.get_header).json()
        checkResponse(r)
        return cls(r["data"])

    def get_hub(self, token):
        '''Returns a specific hub from current project
        Scope data:read'''
        checkScopes(token, "data:read")
        return Hub.hubById(token, self.hub_id)

    def top_folders(self, token):
        '''Returns the details of the highest level folders the user has access 
        to for a given project. 
        The user must have at least read access to the folders.
        Scope data:read'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/project/v1/hubs/{hId}/projects/{pId}/topFolders".format(
            hId=self.hub_id, pId=self.id)

        r = requests.get(endpoint_url, headers=token.get_header).json()
        checkResponse(r)
        return [Folder(tF, self.id) for tF in r["data"]]

class Folder(object):
    _apiType = "folders"
    def __init__(self, rawDict, projectId):
        '''Base folder class'''
        self._raw = rawDict
        self._parent_project_id = projectId
    @property
    def raw(self):
        return self._raw
    @property
    def id(self):
        return self._raw.get("id", None)
    @property
    def name(self):
        return self._raw["attributes"].get("name", None)
    @property
    def displayName(self):
        return self._raw["attributes"].get("displayName", None)
    @property
    def createTime(self):
        return self._raw["attributes"].get("createTime", None)
    @property
    def createUserId(self):
        return self._raw["attributes"].get("createUserId", None)
    @property
    def createUserName(self):
        return self._raw["attributes"].get("createUserName", None)
    @property
    def lastModifiedTime(self):
        return self._raw["attributes"].get("lastModifiedTime", None)
    @property
    def lastModifiedUserId(self):
        return self._raw["attributes"].get("lastModifiedUserId", None)
    @property
    def lastModifiedUserName(self):
        return self._raw["attributes"].get("lastModifiedUserName", None)
    @property
    def objectCount(self):
        return self._raw["attributes"].get("objectCount", None)
    @property
    def hidden(self):
        return self._raw["attributes"].get("hidden", None)
    @property
    def parent_project_id(self):
        return self._parent_project_id

    @classmethod
    def folder_by_id(cls, token: Token, projectId, folderId):
        '''Returns a specific folder by id
        Scope data:read
        projectId: the project id in which the folder is contained
        folderId: the folder id'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/data/v1/projects/{p_id}/folders/{f_id}".format(
            p_id=projectId, f_id=folderId)

        r = requests.get(endpoint_url, headers=token.get_header).json()
        checkResponse(r)
        return cls(r["data"], projectId)


    def create_folder(self, token: Token, project: Project, folderId):
        '''Returns a specific folder by id
        Scope data:read
        p_id: the project id in which the folder is contained
        f_id: the folder id'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/data/v1/projects/{p_id}/folders/{f_id}".format(
            p_id=self.parent_project_id, f_id=self.id)

        r = requests.get(endpoint_url ,headers=token.get_header).json()
        checkResponse(r)
        return Folder(r["data"], self.parent_project_id)

    def get_contents(self, token, projectId):
        '''Returns a collection of items and folders within a folder. 
        Items represent word documents, 
        fusion design files, drawings, spreadsheets, etc.<br>

        Notes:<br><br>

        The tip version for each item resource is included by default in the included 
        array of the payload'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/data/v1/projects/{pId}/folders/{fId}/contents".format(pId=projectId, fId=self.id)
        if token.is_three_legged:
            r = requests.get(endpoint_url ,headers=token.get_header).json()
        elif token.is_three_legged is False:
            r = requests.get(endpoint_url ,headers=token.x_user).json()
        checkResponse(r)
        results = []
        for res in r["data"]:
            if res["type"] == "folders":
                results.append(Folder(res, self.parent_project_id))
            elif res["type"] == "items":
                results.append(Item(res, self.parent_project_id))
            elif res["type"] == "versions":
                results.append(Version(res, self.parent_project_id))
        return results

class Item(object):
    def __init__(self, rawDict, parent_project_id):
        self._raw = rawDict
        self._parent_project_id = parent_project_id
    @property
    def raw(self):
        return self._raw
    @property
    def id(self):
        return self._raw.get("id", None)
    @property
    def displayName(self):
        return self._raw["attributes"].get("displayName", None)
    @property
    def createUserId(self):
        return self._raw["attributes"].get("createUserId", None)
    @property
    def createUserName(self):
        return self._raw["attributes"].get("createUserName", None)
    @property
    def lastModifiedUserId(self):
        return self._raw["attributes"].get("lastModifiedUserId", None)
    @property
    def lastModifiedUserName(self):
        return self._raw["attributes"].get("lastModifiedUserName", None)
    @property
    def lastModifiedTime(self):
        return self._raw["attributes"].get("lastModifiedTime", None)
    @property
    def createTime(self):
        return self._raw["attributes"].get("createTime", None)
    @property
    def hidden(self):
        return self._raw["attributes"].get("hidden", None)
    @property
    def parentFolderId(self):
        return self._raw["relationships"]["parent"]["data"].get("id", None)
    @property
    def parent_project_id(self):
        return self._parent_project_id

    @classmethod
    def item_by_id(cls, token, projectId, itemId):
        '''Retrieves metadata for a specified item. 
        Items represent word documents, fusion design files, drawings, 
        spreadsheets, etc.<br>
        Scope - data:read'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/data/v1/projects/{pId}/items/{itemId}".format(pId=projectId, itemId=itemId)
        r = requests.get(endpoint_url, headers=token.x_user).json()
        checkResponse(r)
        return cls(r, projectId)
    
    def get_versions(self, token):
        '''Retrieves metadata for a specified item. 
        Items represent word documents, fusion design files, drawings, spreadsheets, etc.<br>
        Scope - data:read'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/data/v1/projects/{pId}/items/{itemId}/versions".format(
            pId=self.parent_project_id, itemId=self.id)

        r = requests.get(endpoint_url, headers=token.x_user).json()
        checkResponse(r)
        return [Version(v, self.parent_project_id) for v in r["data"]]


    def get_tip_versions(self, token):
        '''Returns the “tip” version for the given item.<br>
        Multiple versions of a resource item can be uploaded in a project. 
        The tip version is the most recent one.<br>
        Scope - data:read'''
        # TODO Optional filter parameters
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/data/v1/projects/{pId}/items/{itemId}/tip".format(
            pId=self.parent_project_id, itemId=self.id)

        r = requests.get(endpoint_url, headers=token.x_user).json()
        checkResponse(r)
        return Version(r, self.parent_project_id)

class Version(object):
    def __init__(self, rawDict, parent_project_id):
        self._raw = rawDict
        self._parent_project_id = parent_project_id

    @property
    def raw(self):
        return self._raw
    @property
    def id(self):
        return self._raw.get("id", None)
    @property
    def name(self):
        return self._raw["attributes"].get("name", None)
    @property
    def displayName(self):
        return self._raw["attributes"].get("displayName", None)     
    @property
    def createTime(self):
        return self._raw["attributes"].get("createTime", None)      
    @property
    def createUserId(self):
        return self._raw["attributes"].get("createUserId", None)
    @property
    def createUserName(self):
        return self._raw["attributes"].get("createUserName", None)
    @property
    def lastModifiedTime(self):
        return self._raw["attributes"].get("lastModifiedTime", None)
    @property
    def lastModifiedUserId(self):
        return self._raw["attributes"].get("lastModifiedUserId", None)
    @property
    def lastModifiedUserName(self):
        return self._raw["attributes"].get("lastModifiedUserName", None)
    @property
    def versionNumber(self):
        return self._raw["attributes"].get("versionNumber", None)
    @property
    def mimeType(self):
        return self._raw["attributes"].get("mimeType", None)
    @property
    def parent_project_id(self):
        return self._parent_project_id

    @classmethod
    def version_by_id(cls, token, projectId, versionId):
        '''Returns the version with the given version_id<br>
        Scope - data:read'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/data/v1/projects/{pId}/versions/{verId}".format(
            pId=projectId, verId=versionId)

        r = requests.get(endpoint_url, headers=token.x_user).json()
        checkResponse(r)
        return cls(r, projectId)

# TODO LEFT
# Projects
# GET projects/:project_id/downloads/:download_id
# GET projects/:project_id/jobs/:job_id
# POST projects/:project_id/downloads
# POST projects/:project_id/storage

# Folders
# GET projects/:project_id/folders/:folder_id/parent
# GET projects/:project_id/folders/:folder_id/refs
# GET projects/:project_id/folders/:folder_id/relationships/links
# GET projects/:project_id/folders/:folder_id/relationships/refs
# GET projects/:project_id/folders/:folder_id/search
# POST projects/:project_id/folders
# POST projects/:project_id/folders/:folder_id/relationships/refs
# PATCH projects/:project_id/folders/:folder_id

# Items
# GET projects/:project_id/items/:item_id/parent
# GET projects/:project_id/items/:item_id/refs
# GET projects/:project_id/items/:item_id/relationships/links
# GET projects/:project_id/items/:item_id/relationships/refs
# POST projects/:project_id/items
# POST projects/:project_id/items/:item_id/relationships/refs
# PATCH projects/:project_id/items/:item_id

# Versions
# GET projects/:project_id/versions/:version_id/downloadFormats
# GET projects/:project_id/versions/:version_id/downloads
# GET projects/:project_id/versions/:version_id/item
# GET projects/:project_id/versions/:version_id/refs
# GET projects/:project_id/versions/:version_id/relationships/links
# GET projects/:project_id/versions/:version_id/relationships/refs
# POST projects/:project_id/versions
# POST projects/:project_id/versions/:version_id/relationships/refs
# PATCH projects/:project_id/versions/:version_id

# Commands
# CheckPermission
# ListRefs
# ListItems
# CreateFolder
# PublishModel
# GetPublishModelJob

# OSS
# Buckets
# POST buckets
# GET buckets
# GET buckets/:bucketKey/details
# DELETE buckets/:bucketKey

# Objects
# PUT buckets/:bucketKey/objects/:objectName
# PUT buckets/:bucketKey/objects/:objectName/resumable
# GET buckets/:bucketKey/objects/:objectName/status/:sessionId
# GET buckets/:bucketKey/objects
# GET buckets/:bucketKey/objects/:objectName/details
# GET buckets/:bucketKey/objects/:objectName
# POST buckets/:bucketKey/objects/:objectName/signed
# PUT signedresources/:id
# PUT signedresources/:id/resumable
# GET signedresources/:id
# DELETE signedresources/:id
# PUT buckets/:bucketKey/objects/:objectName/copyto/:newObjectName
# DELETE buckets/:bucketKey/objects/:objectName

Classes

class Folder (rawDict, projectId)

Base folder class

Expand source code

class Folder(object):
    _apiType = "folders"
    def __init__(self, rawDict, projectId):
        '''Base folder class'''
        self._raw = rawDict
        self._parent_project_id = projectId
    @property
    def raw(self):
        return self._raw
    @property
    def id(self):
        return self._raw.get("id", None)
    @property
    def name(self):
        return self._raw["attributes"].get("name", None)
    @property
    def displayName(self):
        return self._raw["attributes"].get("displayName", None)
    @property
    def createTime(self):
        return self._raw["attributes"].get("createTime", None)
    @property
    def createUserId(self):
        return self._raw["attributes"].get("createUserId", None)
    @property
    def createUserName(self):
        return self._raw["attributes"].get("createUserName", None)
    @property
    def lastModifiedTime(self):
        return self._raw["attributes"].get("lastModifiedTime", None)
    @property
    def lastModifiedUserId(self):
        return self._raw["attributes"].get("lastModifiedUserId", None)
    @property
    def lastModifiedUserName(self):
        return self._raw["attributes"].get("lastModifiedUserName", None)
    @property
    def objectCount(self):
        return self._raw["attributes"].get("objectCount", None)
    @property
    def hidden(self):
        return self._raw["attributes"].get("hidden", None)
    @property
    def parent_project_id(self):
        return self._parent_project_id

    @classmethod
    def folder_by_id(cls, token: Token, projectId, folderId):
        '''Returns a specific folder by id
        Scope data:read
        projectId: the project id in which the folder is contained
        folderId: the folder id'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/data/v1/projects/{p_id}/folders/{f_id}".format(
            p_id=projectId, f_id=folderId)

        r = requests.get(endpoint_url, headers=token.get_header).json()
        checkResponse(r)
        return cls(r["data"], projectId)


    def create_folder(self, token: Token, project: Project, folderId):
        '''Returns a specific folder by id
        Scope data:read
        p_id: the project id in which the folder is contained
        f_id: the folder id'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/data/v1/projects/{p_id}/folders/{f_id}".format(
            p_id=self.parent_project_id, f_id=self.id)

        r = requests.get(endpoint_url ,headers=token.get_header).json()
        checkResponse(r)
        return Folder(r["data"], self.parent_project_id)

    def get_contents(self, token, projectId):
        '''Returns a collection of items and folders within a folder. 
        Items represent word documents, 
        fusion design files, drawings, spreadsheets, etc.<br>

        Notes:<br><br>

        The tip version for each item resource is included by default in the included 
        array of the payload'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/data/v1/projects/{pId}/folders/{fId}/contents".format(pId=projectId, fId=self.id)
        if token.is_three_legged:
            r = requests.get(endpoint_url ,headers=token.get_header).json()
        elif token.is_three_legged is False:
            r = requests.get(endpoint_url ,headers=token.x_user).json()
        checkResponse(r)
        results = []
        for res in r["data"]:
            if res["type"] == "folders":
                results.append(Folder(res, self.parent_project_id))
            elif res["type"] == "items":
                results.append(Item(res, self.parent_project_id))
            elif res["type"] == "versions":
                results.append(Version(res, self.parent_project_id))
        return results

Static methods

def folder_by_id(token: Token, projectId, folderId)

Returns a specific folder by id Scope data:read projectId: the project id in which the folder is contained folderId: the folder id

Expand source code

@classmethod
def folder_by_id(cls, token: Token, projectId, folderId):
    '''Returns a specific folder by id
    Scope data:read
    projectId: the project id in which the folder is contained
    folderId: the folder id'''
    checkScopes(token, "data:read")
    endpoint_url = BASE_URL+"/data/v1/projects/{p_id}/folders/{f_id}".format(
        p_id=projectId, f_id=folderId)

    r = requests.get(endpoint_url, headers=token.get_header).json()
    checkResponse(r)
    return cls(r["data"], projectId)

Instance variables

var createTime

Expand source code

@property
def createTime(self):
    return self._raw["attributes"].get("createTime", None)

var createUserId

Expand source code

@property
def createUserId(self):
    return self._raw["attributes"].get("createUserId", None)

var createUserName

Expand source code

@property
def createUserName(self):
    return self._raw["attributes"].get("createUserName", None)

var displayName

Expand source code

@property
def displayName(self):
    return self._raw["attributes"].get("displayName", None)

var hidden

Expand source code

@property
def hidden(self):
    return self._raw["attributes"].get("hidden", None)

var id

Expand source code

@property
def id(self):
    return self._raw.get("id", None)

var lastModifiedTime

Expand source code

@property
def lastModifiedTime(self):
    return self._raw["attributes"].get("lastModifiedTime", None)

var lastModifiedUserId

Expand source code

@property
def lastModifiedUserId(self):
    return self._raw["attributes"].get("lastModifiedUserId", None)

var lastModifiedUserName

Expand source code

@property
def lastModifiedUserName(self):
    return self._raw["attributes"].get("lastModifiedUserName", None)

var name

Expand source code

@property
def name(self):
    return self._raw["attributes"].get("name", None)

var objectCount

Expand source code

@property
def objectCount(self):
    return self._raw["attributes"].get("objectCount", None)

var parent_project_id

Expand source code

@property
def parent_project_id(self):
    return self._parent_project_id

var raw

Expand source code

@property
def raw(self):
    return self._raw

Methods

def create_folder(self, token: Token, project: Project, folderId)

Returns a specific folder by id Scope data:read p_id: the project id in which the folder is contained f_id: the folder id

Expand source code

def create_folder(self, token: Token, project: Project, folderId):
    '''Returns a specific folder by id
    Scope data:read
    p_id: the project id in which the folder is contained
    f_id: the folder id'''
    checkScopes(token, "data:read")
    endpoint_url = BASE_URL+"/data/v1/projects/{p_id}/folders/{f_id}".format(
        p_id=self.parent_project_id, f_id=self.id)

    r = requests.get(endpoint_url ,headers=token.get_header).json()
    checkResponse(r)
    return Folder(r["data"], self.parent_project_id)

def get_contents(self, token, projectId)

Returns a collection of items and folders within a folder. Items represent word documents, fusion design files, drawings, spreadsheets, etc.

Notes:

The tip version for each item resource is included by default in the included array of the payload

Expand source code

def get_contents(self, token, projectId):
    '''Returns a collection of items and folders within a folder. 
    Items represent word documents, 
    fusion design files, drawings, spreadsheets, etc.<br>

    Notes:<br><br>

    The tip version for each item resource is included by default in the included 
    array of the payload'''
    checkScopes(token, "data:read")
    endpoint_url = BASE_URL+"/data/v1/projects/{pId}/folders/{fId}/contents".format(pId=projectId, fId=self.id)
    if token.is_three_legged:
        r = requests.get(endpoint_url ,headers=token.get_header).json()
    elif token.is_three_legged is False:
        r = requests.get(endpoint_url ,headers=token.x_user).json()
    checkResponse(r)
    results = []
    for res in r["data"]:
        if res["type"] == "folders":
            results.append(Folder(res, self.parent_project_id))
        elif res["type"] == "items":
            results.append(Item(res, self.parent_project_id))
        elif res["type"] == "versions":
            results.append(Version(res, self.parent_project_id))
    return results

class Hub (rawDict)

Expand source code

class Hub(object):
    _apiType = "hubs"
    def __init__(self, rawDict):
        self._raw = rawDict

    @property
    def apiType(self):
        return self._apiType
    @property
    def raw(self):
        return self._raw
    @property
    def type(self):
        return self._raw.get("type", None)
    @property
    def hub_id(self):
        return self._raw.get("id", None)
    @property
    def name(self):
        return self._raw["attributes"].get("name", None)
    @property
    def region(self):
        return self._raw["attributes"].get("region", None)

    @classmethod
    def hubById(cls, token, hub_id):
        '''Returns info on the hub give<br>
        Scope - data:read'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/project/v1/hubs/{hId}".format(hId=hub_id)
        r = requests.get(endpoint_url, headers=token.get_header).json()
        checkResponse(r)
        return cls(r)

    @classmethod
    def get_hubs(cls, token):
        '''Returns a collection of accessible hubs for this member.<br>
        Scope - data:read<br><br>
        
        Hubs represent BIM 360 Team hubs, Fusion Team hubs 
        (formerly known as A360 Team hubs),
        A360 Personal hubs, or BIM 360 Docs accounts.<br>
        Team hubs include BIM 360 Team hubs and Fusion Team hubs 
        (formerly known as A360 Team hubs). Personal hubs include A360 Personal hubs.'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/project/v1/hubs"
        r = requests.get(endpoint_url, headers=token.get_header).json()
        checkResponse(r)
        return [cls(h) for h in r["data"]]

    def get_projects(self, token):
        '''Returns a list of all projects in the hub<br>
        Scope - data:read'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/project/v1/hubs/{hId}/projects".format(hId=self.hub_id)
        projects = requests.get(endpoint_url,headers=token.get_header).json()
        checkResponse(projects)
        return [Project(p) for p in projects["data"]]

    def project_by_id(self, token, projectId):
        '''Returns a specific project by id
        Scope data:read'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/project/v1/hubs/{hId}/projects/{pId}".format(
            hId=self.hub_id, pId=projectId)
        r = requests.get(endpoint_url, headers=token.get_header).json()
        checkResponse(r)
        return Project(r["data"])

Static methods

def get_hubs(token)

Returns a collection of accessible hubs for this member.
Scope - data:read

Hubs represent BIM 360 Team hubs, Fusion Team hubs (formerly known as A360 Team hubs), A360 Personal hubs, or BIM 360 Docs accounts.
Team hubs include BIM 360 Team hubs and Fusion Team hubs (formerly known as A360 Team hubs). Personal hubs include A360 Personal hubs.

Expand source code

@classmethod
def get_hubs(cls, token):
    '''Returns a collection of accessible hubs for this member.<br>
    Scope - data:read<br><br>
    
    Hubs represent BIM 360 Team hubs, Fusion Team hubs 
    (formerly known as A360 Team hubs),
    A360 Personal hubs, or BIM 360 Docs accounts.<br>
    Team hubs include BIM 360 Team hubs and Fusion Team hubs 
    (formerly known as A360 Team hubs). Personal hubs include A360 Personal hubs.'''
    checkScopes(token, "data:read")
    endpoint_url = BASE_URL+"/project/v1/hubs"
    r = requests.get(endpoint_url, headers=token.get_header).json()
    checkResponse(r)
    return [cls(h) for h in r["data"]]

def hubById(token, hub_id)

Returns info on the hub give
Scope - data:read

Expand source code

@classmethod
def hubById(cls, token, hub_id):
    '''Returns info on the hub give<br>
    Scope - data:read'''
    checkScopes(token, "data:read")
    endpoint_url = BASE_URL+"/project/v1/hubs/{hId}".format(hId=hub_id)
    r = requests.get(endpoint_url, headers=token.get_header).json()
    checkResponse(r)
    return cls(r)

Instance variables

var apiType

Expand source code

@property
def apiType(self):
    return self._apiType

var hub_id

Expand source code

@property
def hub_id(self):
    return self._raw.get("id", None)

var name

Expand source code

@property
def name(self):
    return self._raw["attributes"].get("name", None)

var raw

Expand source code

@property
def raw(self):
    return self._raw

var region

Expand source code

@property
def region(self):
    return self._raw["attributes"].get("region", None)

var type

Expand source code

@property
def type(self):
    return self._raw.get("type", None)

Methods

def get_projects(self, token)

Returns a list of all projects in the hub
Scope - data:read

Expand source code

def get_projects(self, token):
    '''Returns a list of all projects in the hub<br>
    Scope - data:read'''
    checkScopes(token, "data:read")
    endpoint_url = BASE_URL+"/project/v1/hubs/{hId}/projects".format(hId=self.hub_id)
    projects = requests.get(endpoint_url,headers=token.get_header).json()
    checkResponse(projects)
    return [Project(p) for p in projects["data"]]

def project_by_id(self, token, projectId)

Returns a specific project by id Scope data:read

Expand source code

def project_by_id(self, token, projectId):
    '''Returns a specific project by id
    Scope data:read'''
    checkScopes(token, "data:read")
    endpoint_url = BASE_URL+"/project/v1/hubs/{hId}/projects/{pId}".format(
        hId=self.hub_id, pId=projectId)
    r = requests.get(endpoint_url, headers=token.get_header).json()
    checkResponse(r)
    return Project(r["data"])

class Item (rawDict, parent_project_id)

Expand source code

class Item(object):
    def __init__(self, rawDict, parent_project_id):
        self._raw = rawDict
        self._parent_project_id = parent_project_id
    @property
    def raw(self):
        return self._raw
    @property
    def id(self):
        return self._raw.get("id", None)
    @property
    def displayName(self):
        return self._raw["attributes"].get("displayName", None)
    @property
    def createUserId(self):
        return self._raw["attributes"].get("createUserId", None)
    @property
    def createUserName(self):
        return self._raw["attributes"].get("createUserName", None)
    @property
    def lastModifiedUserId(self):
        return self._raw["attributes"].get("lastModifiedUserId", None)
    @property
    def lastModifiedUserName(self):
        return self._raw["attributes"].get("lastModifiedUserName", None)
    @property
    def lastModifiedTime(self):
        return self._raw["attributes"].get("lastModifiedTime", None)
    @property
    def createTime(self):
        return self._raw["attributes"].get("createTime", None)
    @property
    def hidden(self):
        return self._raw["attributes"].get("hidden", None)
    @property
    def parentFolderId(self):
        return self._raw["relationships"]["parent"]["data"].get("id", None)
    @property
    def parent_project_id(self):
        return self._parent_project_id

    @classmethod
    def item_by_id(cls, token, projectId, itemId):
        '''Retrieves metadata for a specified item. 
        Items represent word documents, fusion design files, drawings, 
        spreadsheets, etc.<br>
        Scope - data:read'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/data/v1/projects/{pId}/items/{itemId}".format(pId=projectId, itemId=itemId)
        r = requests.get(endpoint_url, headers=token.x_user).json()
        checkResponse(r)
        return cls(r, projectId)
    
    def get_versions(self, token):
        '''Retrieves metadata for a specified item. 
        Items represent word documents, fusion design files, drawings, spreadsheets, etc.<br>
        Scope - data:read'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/data/v1/projects/{pId}/items/{itemId}/versions".format(
            pId=self.parent_project_id, itemId=self.id)

        r = requests.get(endpoint_url, headers=token.x_user).json()
        checkResponse(r)
        return [Version(v, self.parent_project_id) for v in r["data"]]


    def get_tip_versions(self, token):
        '''Returns the “tip” version for the given item.<br>
        Multiple versions of a resource item can be uploaded in a project. 
        The tip version is the most recent one.<br>
        Scope - data:read'''
        # TODO Optional filter parameters
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/data/v1/projects/{pId}/items/{itemId}/tip".format(
            pId=self.parent_project_id, itemId=self.id)

        r = requests.get(endpoint_url, headers=token.x_user).json()
        checkResponse(r)
        return Version(r, self.parent_project_id)

Static methods

def item_by_id(token, projectId, itemId)

Retrieves metadata for a specified item. Items represent word documents, fusion design files, drawings, spreadsheets, etc.
Scope - data:read

Expand source code

@classmethod
def item_by_id(cls, token, projectId, itemId):
    '''Retrieves metadata for a specified item. 
    Items represent word documents, fusion design files, drawings, 
    spreadsheets, etc.<br>
    Scope - data:read'''
    checkScopes(token, "data:read")
    endpoint_url = BASE_URL+"/data/v1/projects/{pId}/items/{itemId}".format(pId=projectId, itemId=itemId)
    r = requests.get(endpoint_url, headers=token.x_user).json()
    checkResponse(r)
    return cls(r, projectId)

Instance variables

var createTime

Expand source code

@property
def createTime(self):
    return self._raw["attributes"].get("createTime", None)

var createUserId

Expand source code

@property
def createUserId(self):
    return self._raw["attributes"].get("createUserId", None)

var createUserName

Expand source code

@property
def createUserName(self):
    return self._raw["attributes"].get("createUserName", None)

var displayName

Expand source code

@property
def displayName(self):
    return self._raw["attributes"].get("displayName", None)

var hidden

Expand source code

@property
def hidden(self):
    return self._raw["attributes"].get("hidden", None)

var id

Expand source code

@property
def id(self):
    return self._raw.get("id", None)

var lastModifiedTime

Expand source code

@property
def lastModifiedTime(self):
    return self._raw["attributes"].get("lastModifiedTime", None)

var lastModifiedUserId

Expand source code

@property
def lastModifiedUserId(self):
    return self._raw["attributes"].get("lastModifiedUserId", None)

var lastModifiedUserName

Expand source code

@property
def lastModifiedUserName(self):
    return self._raw["attributes"].get("lastModifiedUserName", None)

var parentFolderId

Expand source code

@property
def parentFolderId(self):
    return self._raw["relationships"]["parent"]["data"].get("id", None)

var parent_project_id

Expand source code

@property
def parent_project_id(self):
    return self._parent_project_id

var raw

Expand source code

@property
def raw(self):
    return self._raw

Methods

def get_tip_versions(self, token)

Returns the “tip” version for the given item.
Multiple versions of a resource item can be uploaded in a project. The tip version is the most recent one.
Scope - data:read

Expand source code

def get_tip_versions(self, token):
    '''Returns the “tip” version for the given item.<br>
    Multiple versions of a resource item can be uploaded in a project. 
    The tip version is the most recent one.<br>
    Scope - data:read'''
    # TODO Optional filter parameters
    checkScopes(token, "data:read")
    endpoint_url = BASE_URL+"/data/v1/projects/{pId}/items/{itemId}/tip".format(
        pId=self.parent_project_id, itemId=self.id)

    r = requests.get(endpoint_url, headers=token.x_user).json()
    checkResponse(r)
    return Version(r, self.parent_project_id)

def get_versions(self, token)

Retrieves metadata for a specified item. Items represent word documents, fusion design files, drawings, spreadsheets, etc.
Scope - data:read

Expand source code

def get_versions(self, token):
    '''Retrieves metadata for a specified item. 
    Items represent word documents, fusion design files, drawings, spreadsheets, etc.<br>
    Scope - data:read'''
    checkScopes(token, "data:read")
    endpoint_url = BASE_URL+"/data/v1/projects/{pId}/items/{itemId}/versions".format(
        pId=self.parent_project_id, itemId=self.id)

    r = requests.get(endpoint_url, headers=token.x_user).json()
    checkResponse(r)
    return [Version(v, self.parent_project_id) for v in r["data"]]

class Project (rawDict)

TODO

Expand source code

class Project(object):
    _apiType = "projects"
    def __init__(self, rawDict):
        '''TODO'''
        self._raw = rawDict

    @property
    def id(self):
        return self._raw.get("id", None)
    @property
    def raw(self):
        return self._raw
    @property
    def apiType(self):
        return self._apiType
    @property
    def name(self):
        return self._raw["attributes"].get("name", None)
    @property
    def hub_id(self):
        return self._raw["relationships"]["hub"]["data"].get("id", None)

    @classmethod
    def project_by_id(cls, token, hub_id , pId):
        '''Returns a specific project by id
        Scope data:read'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/project/v1/hubs/{hId}/projects/{pId}".format(
            hId=hub_id, pId=pId)

        r = requests.get(endpoint_url, headers=token.get_header).json()
        checkResponse(r)
        return cls(r["data"])

    def get_hub(self, token):
        '''Returns a specific hub from current project
        Scope data:read'''
        checkScopes(token, "data:read")
        return Hub.hubById(token, self.hub_id)

    def top_folders(self, token):
        '''Returns the details of the highest level folders the user has access 
        to for a given project. 
        The user must have at least read access to the folders.
        Scope data:read'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/project/v1/hubs/{hId}/projects/{pId}/topFolders".format(
            hId=self.hub_id, pId=self.id)

        r = requests.get(endpoint_url, headers=token.get_header).json()
        checkResponse(r)
        return [Folder(tF, self.id) for tF in r["data"]]

Static methods

def project_by_id(token, hub_id, pId)

Returns a specific project by id Scope data:read

Expand source code

@classmethod
def project_by_id(cls, token, hub_id , pId):
    '''Returns a specific project by id
    Scope data:read'''
    checkScopes(token, "data:read")
    endpoint_url = BASE_URL+"/project/v1/hubs/{hId}/projects/{pId}".format(
        hId=hub_id, pId=pId)

    r = requests.get(endpoint_url, headers=token.get_header).json()
    checkResponse(r)
    return cls(r["data"])

Instance variables

var apiType

Expand source code

@property
def apiType(self):
    return self._apiType

var hub_id

Expand source code

@property
def hub_id(self):
    return self._raw["relationships"]["hub"]["data"].get("id", None)

var id

Expand source code

@property
def id(self):
    return self._raw.get("id", None)

var name

Expand source code

@property
def name(self):
    return self._raw["attributes"].get("name", None)

var raw

Expand source code

@property
def raw(self):
    return self._raw

Methods

def get_hub(self, token)

Returns a specific hub from current project Scope data:read

Expand source code

def get_hub(self, token):
    '''Returns a specific hub from current project
    Scope data:read'''
    checkScopes(token, "data:read")
    return Hub.hubById(token, self.hub_id)

def top_folders(self, token)

Returns the details of the highest level folders the user has access to for a given project. The user must have at least read access to the folders. Scope data:read

Expand source code

def top_folders(self, token):
    '''Returns the details of the highest level folders the user has access 
    to for a given project. 
    The user must have at least read access to the folders.
    Scope data:read'''
    checkScopes(token, "data:read")
    endpoint_url = BASE_URL+"/project/v1/hubs/{hId}/projects/{pId}/topFolders".format(
        hId=self.hub_id, pId=self.id)

    r = requests.get(endpoint_url, headers=token.get_header).json()
    checkResponse(r)
    return [Folder(tF, self.id) for tF in r["data"]]

class Version (rawDict, parent_project_id)

Expand source code

class Version(object):
    def __init__(self, rawDict, parent_project_id):
        self._raw = rawDict
        self._parent_project_id = parent_project_id

    @property
    def raw(self):
        return self._raw
    @property
    def id(self):
        return self._raw.get("id", None)
    @property
    def name(self):
        return self._raw["attributes"].get("name", None)
    @property
    def displayName(self):
        return self._raw["attributes"].get("displayName", None)     
    @property
    def createTime(self):
        return self._raw["attributes"].get("createTime", None)      
    @property
    def createUserId(self):
        return self._raw["attributes"].get("createUserId", None)
    @property
    def createUserName(self):
        return self._raw["attributes"].get("createUserName", None)
    @property
    def lastModifiedTime(self):
        return self._raw["attributes"].get("lastModifiedTime", None)
    @property
    def lastModifiedUserId(self):
        return self._raw["attributes"].get("lastModifiedUserId", None)
    @property
    def lastModifiedUserName(self):
        return self._raw["attributes"].get("lastModifiedUserName", None)
    @property
    def versionNumber(self):
        return self._raw["attributes"].get("versionNumber", None)
    @property
    def mimeType(self):
        return self._raw["attributes"].get("mimeType", None)
    @property
    def parent_project_id(self):
        return self._parent_project_id

    @classmethod
    def version_by_id(cls, token, projectId, versionId):
        '''Returns the version with the given version_id<br>
        Scope - data:read'''
        checkScopes(token, "data:read")
        endpoint_url = BASE_URL+"/data/v1/projects/{pId}/versions/{verId}".format(
            pId=projectId, verId=versionId)

        r = requests.get(endpoint_url, headers=token.x_user).json()
        checkResponse(r)
        return cls(r, projectId)

Static methods

def version_by_id(token, projectId, versionId)

Returns the version with the given version_id
Scope - data:read

Expand source code

@classmethod
def version_by_id(cls, token, projectId, versionId):
    '''Returns the version with the given version_id<br>
    Scope - data:read'''
    checkScopes(token, "data:read")
    endpoint_url = BASE_URL+"/data/v1/projects/{pId}/versions/{verId}".format(
        pId=projectId, verId=versionId)

    r = requests.get(endpoint_url, headers=token.x_user).json()
    checkResponse(r)
    return cls(r, projectId)

Instance variables

var createTime

Expand source code

@property
def createTime(self):
    return self._raw["attributes"].get("createTime", None)      

var createUserId

Expand source code

@property
def createUserId(self):
    return self._raw["attributes"].get("createUserId", None)

var createUserName

Expand source code

@property
def createUserName(self):
    return self._raw["attributes"].get("createUserName", None)

var displayName

Expand source code

@property
def displayName(self):
    return self._raw["attributes"].get("displayName", None)     

var id

Expand source code

@property
def id(self):
    return self._raw.get("id", None)

var lastModifiedTime

Expand source code

@property
def lastModifiedTime(self):
    return self._raw["attributes"].get("lastModifiedTime", None)

var lastModifiedUserId

Expand source code

@property
def lastModifiedUserId(self):
    return self._raw["attributes"].get("lastModifiedUserId", None)

var lastModifiedUserName

Expand source code

@property
def lastModifiedUserName(self):
    return self._raw["attributes"].get("lastModifiedUserName", None)

var mimeType

Expand source code

@property
def mimeType(self):
    return self._raw["attributes"].get("mimeType", None)

var name

Expand source code

@property
def name(self):
    return self._raw["attributes"].get("name", None)

var parent_project_id

Expand source code

@property
def parent_project_id(self):
    return self._parent_project_id

var raw

Expand source code

@property
def raw(self):
    return self._raw

var versionNumber

Expand source code

@property
def versionNumber(self):
    return self._raw["attributes"].get("versionNumber", None)