{ "opencollection": "1.0.0", "info": { "name": "Construction.Account.Admin Account Users 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." } ] } ], "bundled": true }