{ "opencollection": "1.0.0", "info": { "name": "Construction.Account.Admin Account Management Versions API", "version": "1.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Versions", "type": "folder" }, "items": [ { "info": { "name": "Get a Version", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/versions/:version_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": "version_id", "value": "", "type": "path", "description": "The URL encoded unique identifier of a version." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the specified version of an item.\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": "Update a Version", "type": "http" }, "http": { "method": "PATCH", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/versions/:version_id", "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": "version_id", "value": "", "type": "path", "description": "The URL encoded unique identifier of a version." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates the properties of the specified version of an item. Currently, you can only change the name of the version.\n\n**Note:** This operation is not supported for BIM 360 and ACC. If you want to rename a version, create a new version with a new name.\n" }, { "info": { "name": "Get Item by Version", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/versions/:version_id/item", "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": "version_id", "value": "", "type": "path", "description": "The URL encoded unique identifier of a version." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the item corresponding to the specified version.\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 Version", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/versions/:version_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": "version_id", "value": "", "type": "path", "description": "The URL encoded unique identifier of a version." }, { "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 version.\n\nCustom relationships can be established between a version of an item and other resources within the data domain service (folders, items, and versions).\n\n- Each relationship is defined by the id of the object at the other end of the relationship, together with type, attributes, and relationships links.\n- Callers will typically use a filter parameter to restrict the response to the cus" }, { "info": { "name": "List Custom Relationships for a Version", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/versions/:version_id/relationships/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": "version_id", "value": "", "type": "path", "description": "The URL encoded unique identifier of a version." }, { "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 for the specified version. \n\nCustom relationships can be established between a version of an item and other resources within the data domain service (folders, items, and versions).\n\n- Each 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.\n- Callers will typically use a filter parameter to restrict the response to the custom relationship types (``filter[meta.r" }, { "info": { "name": "Create a Custom Relationship for a Version", "type": "http" }, "http": { "method": "POST", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/versions/:version_id/relationships/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": "version_id", "value": "", "type": "path", "description": "The URL encoded unique identifier of a version." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a custom relationship between a version of an item and another resource within the data domain service (folder, item, or version)." }, { "info": { "name": "List Links for a Version", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/projects/:project_id/versions/:version_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": "version_id", "value": "", "type": "path", "description": "The URL encoded unique identifier of a version." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a collection of links for the specified version of an item. Custom relationships can be established between a version of an item and other external resources residing outside the data domain service. A link’s href defines the target URI to access the 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 Version", "type": "http" }, "http": { "method": "POST", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/versions", "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": "copyFrom", "value": "", "type": "query", "description": "The Version ID (URN) of the version to copy from. \n\n**Note**: This parameter is relevant only for copying files to BIM 360 Docs.\n\nFor information on how to find the URN, see the initial steps of the [Download a File](/en/docs/data/v2/tutorials/download-file/) tutorial.\n\nYou can only copy files to the Plans folder or to subfolders of the Plans folder with an ``item:autodesk.bim360:Document`` item extension type. You can only copy files to the Project Files folder or to subfolders of the Project Files folder with an ``item:autodesk.bim360:File`` item extension type. \n\nTo verify an item’s extension type, use the [Get an Item](/en/docs/data/v2/reference/http/projects-project_id-items-item_id-GET/) operation, and check the ``attributes.extension.type`` attribute. \n\nNote that if you copy a file to the Plans folder or to a subfolder of the Plans folder, the copied file inherits the permissions of the source file. For example, if users of your app did not have permission to download files in the source folder, but does have permission to download files in the target folder, they will not be able to download the copied file. \n\nNote that you cannot copy a file while it is being uploaded, updated, or copied. To verify the current process state of a file, call the [Get an Item](en/docs/data/v2/reference/http/projects-project_id-items-item_id-GET/) operation , and check the ``attributes.extension.data.processState`` attribute.\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new versions of an existing item.\n\nBefore creating a new version you must create a storage location for the version in OSS, and upload the file to that location. For more details about the workflow, see the tutorial on uploading a file.\n\nThis operation also allows you to create a new version of an item by copying a specific version of an existing item from another folder within the project. The new version becomes the tip version of the item.\n\nUse the [Create an Item](/en/docs/data/v2/" }, { "info": { "name": "List Supported Download Formats", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/versions/:version_id/downloadFormats", "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": "version_id", "value": "", "type": "path", "description": "The URL encoded unique identifier of a version." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of file formats the specified version of an item can be downloaded as.\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 Available Download Formats", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/versions/:version_id/downloads", "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": "version_id", "value": "", "type": "path", "description": "The URL encoded unique identifier of a version." }, { "name": "filter[format.fileType]", "value": "", "type": "query", "description": "Filter by the file type of the download object." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the list of file formats of the specified version of an item currently available for download.\n\n**Note:** This operation is not fully implemented as yet. It currently returns an empty data object." } ] } ], "bundled": true }