{ "opencollection": "1.0.0", "info": { "name": "Construction.Account.Admin Account Management Projects API", "version": "1.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "Get Project in account", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/construction/admin/v1/accounts/:accountId/projects", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "Region", "value": "" }, { "name": "User-Id", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The ID of the ACC account that contains the project being created or the projects being retrieved. This corresponds to the hub ID in the Data Management API. To convert a hub ID into an account ID, remove the “b.” prefix. For example, a hub ID of b.c8b0c73d-3ae9 translates to an account ID of c8b0c73d-3ae9." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of the project fields to include in the response. Default value: all fields." }, { "name": "filter[classification]", "value": "", "type": "query", "description": "A list of the classifications of projects to include in the response. Possible values: production, template, component, sample." }, { "name": "filter[platform]", "value": "", "type": "query", "description": "Filter resource by platform. Possible values: acc and bim360." }, { "name": "filter[products]", "value": "", "type": "query", "description": "A comma-separated list of the products that the returned projects must use. Only projects that use one or more of the listed products are returned." }, { "name": "filter[name]", "value": "", "type": "query", "description": "A project name or name pattern to filter projects by. Can be a partial match based on the value of filterTextMatch that you provide; for example: filter[name]=ABCco filterTextMatch=startsWith. Max length: 255" }, { "name": "filter[type]", "value": "", "type": "query", "description": "A list of project types to filter projects by. To exclude a project type from the response, prefix it with - (a hyphen); for example, -Bridge excludes bridge projects." }, { "name": "filter[status]", "value": "", "type": "query", "description": "A list of the statuses of projects to include in the response. Possible values: active pending archived suspended" }, { "name": "filter[businessUnitId]", "value": "", "type": "query", "description": "The ID of the business unit that returned projects must be associated with." }, { "name": "filter[jobNumber]", "value": "", "type": "query", "description": "The user-defined identifier for a project to be returned. This ID was defined when the project was created. This filter accepts a partial match based on the value of filterTextMatch that you provide." }, { "name": "filter[updatedAt]", "value": "", "type": "query", "description": "A range of dates during which the desired projects were updated. The range must be specified with dates in ISO 8601 format with time required. Separate multiple values with commas." }, { "name": "filterTextMatch", "value": "", "type": "query", "description": "When filtering on a text-based field, this value indicates how to do the matching. Default value: contains. Possible values: contains, startsWith, endsWith and equals." }, { "name": "sort", "value": "", "type": "query", "description": "A list of fields to sort the returned projects by. Multiple sort fields are applied in sequence order — each sort field produces groupings of projects with the same values of that field; the next sort field applies within the groupings produced by the previous sort field." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records to return in a single request. Possible range: 1-200. Default value: 20." }, { "name": "offset", "value": "", "type": "query", "description": "The record number that the returned page should start with. When the total number of records exceeds the value of limit, increase the offset value in subsequent requests to continue getting the remaining results." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a list of the projects in the specified account." }, { "info": { "name": "Create new Project", "type": "http" }, "http": { "method": "POST", "url": "https://developer.api.autodesk.com/construction/admin/v1/accounts/:accountId/projects", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "Region", "value": "" }, { "name": "User-Id", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The ID of the ACC account that contains the project being created or the projects being retrieved. This corresponds to the hub ID in the Data Management API. To convert a hub ID into an account ID, remove the “b.” prefix. For example, a hub ID of b.c8b0c73d-3ae9 translates to an account ID of c8b0c73d-3ae9." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new project in the specified account. You can create the project directly, or clone the project from a project template." }, { "info": { "name": "Get a project by ID", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/construction/admin/v1/projects/:projectId", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "Region", "value": "" }, { "name": "User-Id", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of the project fields to include in the response. Default value: all fields." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a project specified by project ID." }, { "info": { "name": "Create or update a project’s image", "type": "http" }, "http": { "method": "PATCH", "url": "https://developer.api.autodesk.com/hq/v1/accounts/:account_id/projects/:project_id/image", "headers": [ { "name": "Region", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The account ID of the project. This corresponds to hub ID in the Data Management API. To convert a hub ID into an account ID you need to remove the “b.” prefix. For example, a hub ID of b.c8b0c73d-3ae9 translates to an account ID of c8b0c73d-3ae9." }, { "name": "account_id", "value": "", "type": "path", "description": "The ID of the project. This corresponds to project ID in the Data Management API. To convert a project ID in the Data Management API into a project ID in the BIM 360 API you need to remove the “b.” prefix. For example, a project ID of b.a4be0c34a-4ab7 translates to a project ID of a4be0c34a-4ab7." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "body", "value": "" } ] }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create or update a project’s image." }, { "info": { "name": "Get Projects", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/project/v1/hubs/:hub_id/projects", "headers": [ { "name": "x-user-id", "value": "" } ], "params": [ { "name": "hub_id", "value": "", "type": "path", "description": "The unique identifier of a hub." }, { "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": "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." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a collection of active projects within the specified hub. The returned projects can be Autodesk Construction Cloud (ACC), BIM 360, BIM 360 Team, Fusion Team, and A360 Personal projects. \n\nFor BIM 360 and ACC projects a hub ID corresponds to an Account ID. To convert an Account ID to a hub ID, prefix the account ID with ``b.``. For example, a BIM 360 account ID of ```c8b0c73d-3ae9``` translates to a hub ID of ``b.c8b0c73d-3ae9``.\n\nSimilarly, to convert a BIM 360 and ACC project IDs to Da" }, { "info": { "name": "Get a Project", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/project/v1/hubs/:hub_id/projects/:project_id", "headers": [ { "name": "x-user-id", "value": "" } ], "params": [ { "name": "hub_id", "value": "", "type": "path", "description": "The unique identifier of a hub." }, { "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" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the specified project from within the specified hub.\n\nFor BIM 360 Docs, a hub ID corresponds to a BIM 360 account ID. To convert a BIM 360 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 a BIM 360 project ID to a Data Management project ID prefix the BIM 360 Project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of `" }, { "info": { "name": "Get Hub for Project", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/project/v1/hubs/:hub_id/projects/:project_id/hub", "headers": [ { "name": "x-user-id", "value": "" } ], "params": [ { "name": "hub_id", "value": "", "type": "path", "description": "The unique identifier of a hub." }, { "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" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the hub that contains the project specified by the ``project_id`` parameter.\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 Top-level Project Folders", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/project/v1/hubs/:hub_id/projects/:project_id/topFolders", "headers": [ { "name": "x-user-id", "value": "" } ], "params": [ { "name": "hub_id", "value": "", "type": "path", "description": "The unique identifier of a hub." }, { "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": "excludeDeleted", "value": "", "type": "query", "description": "Specifies whether deleted folders are excluded from the response for BIM 360 Docs projects, when user context is provided. \n\n- ``true``: Response excludes deleted folders for BIM 360 Docs projects. \n- ``false``: (Default) Response will not exclude deleted folders for BIM 360 Docs projects.\n" }, { "name": "projectFilesOnly", "value": "", "type": "query", "description": "Specifies what folders and subfolders to return for BIM 360 Docs projects, when user context is provided. \n\n- ``true``: Response will be restricted to folder and subfolders containing project files for BIM 360 Docs projects. \n- ``false``: (Default) Response will include all available folders.\n" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the details of the highest level folders within a project that the user calling this operation has access to. The user must have at least read access to the folders.\n\nIf the user is a Project Admin, it returns all top-level folders in the project. Otherwise, it returns all the highest level folders in the folder hierarchy the user has access to.\n\nUsers with access permission to a folder has access permission to all its subfolders.\n\n**Note:** This operation supports Autodesk Construction " }, { "info": { "name": "Create a Storage Location in OSS", "type": "http" }, "http": { "method": "POST", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/storage", "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 placeholder for an item or a version of an item in the OSS. Later, you can upload the binary content for the item or version to this storage location.\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": "Get Download Details", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/downloads/:download_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": "download_id", "value": "", "type": "path", "description": "The Job ID of the job used to generate the download." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the details of a downloadable format of a version of an item.\n" }, { "info": { "name": "Create Download", "type": "http" }, "http": { "method": "POST", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_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" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Kicks off a job to generate the specified download format of the version. Once the job completes, the specified format becomes available for download. \n" }, { "info": { "name": "Check Download Creation Progress", "type": "http" }, "http": { "method": "GET", "url": "https://developer.api.autodesk.com/data/v1/projects/:project_id/jobs/:job_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": "job_id", "value": "", "type": "path", "description": "The unique identifier of a job." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Checks the status of a job that generates a downloadable format of a version of an item. \n\n**Note**: If the job has finished, this operation returns a HTTP status 303, with the ``location`` return header set to the URI that returns the details of the download.\n" } ] } ], "bundled": true }