{ "opencollection": "1.0.0", "info": { "name": "Construction.Account.Admin Account Management Folders API", "version": "1.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Folders", "type": "folder" }, "items": [ { "info": { "name": "Get a Folder", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/folders/:folder_id", "headers": [ { "name": "If-Modified-Since", "value": "" }, { "name": "x-user-id", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of a project. \n\nFor BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with ``b.``. For example, an Account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``.\n\nSimilarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``.\n" }, { "name": "folder_id", "value": "", "type": "path", "description": "The unique identifier of a folder." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the folder specified by the ``folder_id`` parameter from within the project identified by the ``project_id`` parameter. All folders and subfolders within a project (including the root folder) have a unique ID.\n\n**Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). " }, { "info": { "name": "Modify a Folder", "type": "http" }, "http": { "method": "PATCH", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/folders/:folder_id", "headers": [ { "name": "x-user-id", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of a project. \n\nFor BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with ``b.``. For example, an Account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``.\n\nSimilarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``.\n" }, { "name": "folder_id", "value": "", "type": "path", "description": "The unique identifier of a folder." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Renames, moves, hides, or unhides a folder. Marking a BIM 360 Docs folder as hidden effectively deletes it. You can restore it by changing its ``hidden`` attribute. You can also move BIM 360 Docs folders by changing their parent folder.\n\nYou cannot permanently delete BIM 360 Docs folders. They are tagged as hidden folders and are removed from the BIM 360 Docs UI and from regular Data Management API responses. You can use the hidden filter (``filter[hidden]=true``) to get a list of deleted folder" }, { "info": { "name": "Get Parent of a Folder", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/folders/:folder_id/parent", "headers": [ { "name": "x-user-id", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of a project. \n\nFor BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with ``b.``. For example, an Account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``.\n\nSimilarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``.\n" }, { "name": "folder_id", "value": "", "type": "path", "description": "The unique identifier of a folder." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the parent folder of the specified folder. In a project, folders are organized in a hierarchy. Each folder except for the root folder has a parent folder.\n\n**Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). " }, { "info": { "name": "List Folder Contents", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/folders/:folder_id/contents", "headers": [ { "name": "x-user-id", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of a project. \n\nFor BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with ``b.``. For example, an Account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``.\n\nSimilarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``.\n" }, { "name": "folder_id", "value": "", "type": "path", "description": "The unique identifier of a folder." }, { "name": "filter[type]", "value": "", "type": "query", "description": "Filter by the type of the objects in the folder. Supported values are ``folders`` and ``items``." }, { "name": "filter[id]", "value": "", "type": "query", "description": "Filter by the ``id`` of the ``ref`` target." }, { "name": "filter[extension.type]", "value": "", "type": "query", "description": "Filter by the extension type. \n" }, { "name": "filter[lastModifiedTimeRollup]", "value": "", "type": "query", "description": "Filter by the ``lastModifiedTimeRollup`` attribute. Supported values are date-time string in the form ``YYYY-MM-DDTHH:MM:SS.000000Z`` or ``YYYY-MM-DDTHH:MM:SS`` based on RFC3339." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specifies what page to return. Page numbers are 0-based (the first page is page 0)." }, { "name": "page[limit]", "value": "", "type": "query", "description": "Specifies the maximum number of elements to return in the page. The default value is 200. The min value is 1. The max value is 200." }, { "name": "includeHidden", "value": "", "type": "query", "description": "``true``: Response will contain items and folders that were deleted from BIM 360 Docs projects. \n\n``false``: (Default): Response will not contain items and folders that were deleted from BIM 360 Docs projects. \n\nTo return only items and folders that were deleted from BIM 360 Docs projects, see the documentation on [Filtering](/en/docs/data/v2/overview/filtering/).\n" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of items and folders within the specified folder. Items represent word documents, fusion design files, drawings, spreadsheets, etc.\n\nThe resources contained in the ``included`` array of the response are their tip versions.\n\n**Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). " }, { "info": { "name": "List Related Resources for a Folder", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/folders/:folder_id/refs", "headers": [ { "name": "x-user-id", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of a project. \n\nFor BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with ``b.``. For example, an Account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``.\n\nSimilarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``.\n" }, { "name": "folder_id", "value": "", "type": "path", "description": "The unique identifier of a folder." }, { "name": "filter[type]", "value": "", "type": "query", "description": "Filter by the ``type`` of the ``ref`` target. Supported values include ``folders``, ``items``, and ``versions``." }, { "name": "filter[id]", "value": "", "type": "query", "description": "Filter by the ``id`` of the ``ref`` target." }, { "name": "filter[extension.type]", "value": "", "type": "query", "description": "Filter by the extension type. \n" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the resources (items, folders, and versions) that have a custom relationship with the specified folder. Custom relationships can be established between a folder and other resources within the data domain service (folders, items, and versions).\n\nEach relationship is defined by the id of the object at the other end of the relationship, together with type, attributes, and relationships links.\nCallers will typically use a filter parameter to restrict the response to the custom relationship t" }, { "info": { "name": "List Folder and Subfolder Contents", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/folders/:folder_id/search", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of a project. \n\nFor BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with ``b.``. For example, an Account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``.\n\nSimilarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``.\n" }, { "name": "folder_id", "value": "", "type": "path", "description": "The unique identifier of a folder." }, { "name": "filter[*]", "value": "", "type": "query", "description": "Filter the data. See the [Filtering](/en/docs/data/v2/overview/filtering/) section for details." }, { "name": "page[number]", "value": "", "type": "query", "description": "Specifies what page to return. Page numbers are 0-based (the first page is page 0)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Searches the specified folder and its subfolders and returns a list of the latest versions of the items you can access.\n\n\nUse the ``filter`` query string parameter to narrow down the list as appropriate. You can filter by the following properties of the version payload: \n\n- ``type`` property, \n- ``id`` property, \n- any of the attributes object properties. \n\nFor example, you can filter by ``createTime`` and ``mimeType``. It returns tip versions (latest versions) of properties where the filter con" }, { "info": { "name": "List Custom Relationships for a Folder", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/folders/:folder_id/relationships/refs", "headers": [ { "name": "x-user-id", "value": "" } ], "params": [ { "name": "folder_id", "value": "", "type": "path", "description": "The unique identifier of a folder." }, { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of a project. \n\nFor BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with ``b.``. For example, an Account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``.\n\nSimilarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``.\n" }, { "name": "filter[type]", "value": "", "type": "query", "description": "Filter by the ``type`` of the ``ref`` target. Supported values include ``folders``, ``items``, and ``versions``." }, { "name": "filter[id]", "value": "", "type": "query", "description": "Filter by the ``id`` of the ``ref`` target." }, { "name": "filter[refType]", "value": "", "type": "query", "description": "Filter by ``refType``. Possible values: ``derived``, ``dependencies``, ``auxiliary``, ``xrefs``, and ``includes``." }, { "name": "filter[direction]", "value": "", "type": "query", "description": "Filter by the direction of the reference. Possible values: ``from`` and ``to``." }, { "name": "filter[extension.type]", "value": "", "type": "query", "description": "Filter by the extension type. \n" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the custom relationships associated with the specified folder. Custom relationships can be established between a folder and other resources within the data domain service (folders, items, and versions).\n\nEach relationship is defined by the ID of the object at the other end of the relationship, together with type, specific reference meta including extension data.\nCallers will typically use a filter parameter to restrict the response to the custom relationship types (``filter[meta.refType]" }, { "info": { "name": "Create a Custom Relationship for a Folder", "type": "http" }, "http": { "method": "POST", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/folders/:folder_id/relationships/refs", "headers": [ { "name": "x-user-id", "value": "" } ], "params": [ { "name": "folder_id", "value": "", "type": "path", "description": "The unique identifier of a folder." }, { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of a project. \n\nFor BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with ``b.``. For example, an Account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``.\n\nSimilarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``.\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a custom relationship between a folder and another resource within the data domain service (folder, item, or version)." }, { "info": { "name": "List Relationship Links for a Folder", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/folders/:folder_id/relationships/links", "headers": [ { "name": "x-user-id", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of a project. \n\nFor BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with ``b.``. For example, an Account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``.\n\nSimilarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``.\n" }, { "name": "folder_id", "value": "", "type": "path", "description": "The unique identifier of a folder." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of links for the specified folder. \n\nCustom relationships can be established between a folder and other external resources residing outside the data domain service. A link’s ``href`` attribute defines the target URI to access a resource.\n\n**Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](https://en.docs.acc.v1/overview/introduction/). " }, { "info": { "name": "Create a Folder", "type": "http" }, "http": { "method": "POST", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/folders", "headers": [ { "name": "x-user-id", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of a project. \n\nFor BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with ``b.``. For example, an Account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``.\n\nSimilarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``.\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new folder in the specified project. Use the ``parent`` attribute in the request body to specify where in the hierarchy the new folder should be located. Folders can be nested up to 25 levels deep.\n\nUse the `Modify a Folder `_ operation to delete and restore folders.\n\nBefore you use the Data Management API to access BIM 360 Docs folders, provision your app through the BIM 360 Account Administrator portal. For" } ] } ], "bundled": true }