Update project | Autodesk API Documentation POC

Proposed - Update the requested project. Can be used to add or remove products from a project.

Note: This operation is not backward compatible with BIM 360 projects. It only works with Autodesk Construction Cloud projects.

Authentication

AuthorizationBearer

OAuth 2.0 (2-legged with impersonation) — application context with user impersonation required. Send a User-Id header identifying the member to act on behalf of; the token authorizes the application, while the operation is evaluated against that member’s project permissions.

Client Credentials Flow

Token URL: https://developer.api.autodesk.com/authentication/v2/token

Scopes:

account:read — read account and project data
account:write — modify account and project data

AuthorizationBearer

OAuth 2.0 (3-legged) — user context required. Also accepts a Secure Service Account (SSA) token, which is headless like a two-legged flow but classified as three-legged because it preserves user context.

Authorization Code Flow

Authorization URL: https://developer.api.autodesk.com/authentication/v2/authorize

Token URL: https://developer.api.autodesk.com/authentication/v2/token

Refresh URL: https://developer.api.autodesk.com/authentication/v2/token

Scopes:

data:read — read your data
account:read — read account and project data
account:write — modify account and project data

Path parameters

projectIdstringRequiredformat: "uuid"

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 Forma 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.

Headers

User-IdstringOptionalformat: "uuidOrAutodeskId"

The ID of a user on whose behalf your request is acting.

Your app has access to all users specified by the administrator in the SaaS integrations UI. Provide this header value to identify the user to be affected by the request.

You can use either the user’s Forma ID (id), or their Autodesk ID (autodeskId).

Note that this header is required for hub Admin POST, PATCH, and DELETE endpoints if you want to use a 2-legged authentication context. This header is optional for hub Admin GET endpoints.

Request

The fields to update in the project. To add a product to the project include the products array with existing products plus the new product. To remove a product from the project exclude that product from the products array. Must include projectAdministration if updating products. The template object is valid only if adding the documentManagement or field products.

namestringOptional<=255 characters

The name of the project.

startDatedate or nullOptional

The estimated start date for the project, in ISO 8601 format.

endDatedate or nullOptional

The estimated end date for the project, in ISO 8601 format.

typestringOptional<=255 characters

The type of the project. Any value is accepted, but the following are recommended:

Possible values: Convention Center, Data Center, Hotel / Motel, Office, Parking Structure / Garage, Performing Arts, Restaurant, Retail, Stadium / Arena, Theme Park, Warehouse (non-manufacturing), Assisted Living / Nursing Home, Hospital, Medical Laboratory, Medical Office, OutPatient Surgery Center, Court House, Dormitory, Education Facility, Government Building, Library, Military Facility, Museum, Prison / Correctional Facility, Recreation Building, Religious Building, Research Facility / Laboratory, Multi-Family Housing, Single-Family Housing, Airport, Bridge, Canal / Waterway, Dams / Flood Control / Reservoirs, Harbor / River Development, Rail, Seaport, Streets / Roads / Highways, Transportation Building, Tunnel, Waste Water / Sewers, Water Supply, Manufacturing / Factory, Mining Facility, Oil & Gas, Plant, Power Plant, Solar Farm, Utilities, Wind Farm, Demonstration Project, Template Project and Training Project.

classificationenumOptionalDefaults to production

The classification of the project. Possible values:

production – Standard project.
template – A project that serves as a template for creating new projects.
component – A placeholder project containing reusable components (e.g., forms). Only one component project is allowed per hub. Known as a library in the Forma UI.
sample – A single sample project automatically created for Forma trials (limited to one per hub).

Allowed values:

projectValueobjectOptional

Contains details about the estimated cost of the project, including the amount (value) and the currency (currency).

statusenumOptionalDefaults to active

The status of the project.

Possible values: active, pending, archived and suspended.

Allowed values:

jobNumberstringOptional<=100 characters

A user-defined identifier for the project. This value is assigned when the project is created and can be used to filter projects. It supports partial matches when used with filterTextMatch.

addressLine1string or nullOptional<=255 characters

The first line of the project’s address.

addressLine2string or nullOptional<=255 characters

Additional address details for the project location.

citystring or nullOptional<=255 characters

The city wher the project is located.

stateOrProvincestring or nullOptional<=255 characters

The state or province where the project is located. It must be a valid name or an ISO 3166-2 code. The provided state or province must exist in the country of the project.

postalCodestring or nullOptional<=255 characters

The postal or ZIP code of the project location.

countrystring or nullOptional<=255 characters

The country where the project is located, using an ISO 3166-1 alpha-2 code.

latitudestring or nullOptional<=25 characters

The latitude coordinate of the project location.

longitudestring or nullOptional<=25 characters

The longitude coordinate of the project location.

timezoneenum or nullOptional

The time zone where the project is located. It must be a valid IANA time zone name from the IANA Time Zone Database (e.g., America/New_York). If no time zone is set, this field may be null.

constructionTypestringOptional

The type of construction for the project. Recommended values: New Construction, Renovation. Any value is accepted.

deliveryMethodstringOptional

The method used to deliver the project. Recommended values include Design-Bid-Build, Construction Management (CM) at Risk, and Integrated Project Delivery (IPD). Any value is accepted.

contractTypestringOptional

The type of contract for the project. For example, Lump Sum, Cost Plus, Guaranteed Maximum Price, Unit Price. Any value is accepted.

currentPhasestringOptional

The current phase of the project. Recommended values include, Concept, Design, Bidding, Planning, Preconstruction, Construction, Commissioning, Warranty, Complete, Facility Management, Operation, Strategic Definition, Preparation and Brief, Concept Design, Developed Design, Technical Design, Construction, Handover and Close Out and In Use.

Any value is accepted.

sheetCountinteger or nullOptional

The total number of sheets associated with the project.

Note that this field is relevant only in responses. It is ignored in requests.

businessUnitIdstringOptionalformat: "uuid"

The ID of the business unit that the project is associated with.

productslist of objectsOptional

An array of the product objects associated with the project.

Note that this array is relevant only in responses. It is ignored in requests.

When a project is created, every product in the same hub as the project is activated for the project. You can call PATCH users/:userId to separately activate one or more of the returned products for each user assigned to the project.

companyCountintegerOptional

The total number of companies associated with the project.

Note that this field is relevant only in responses. It is ignored in requests.

memberCountintegerOptional

The total number of members on the project.

Note that this field is relevant only in responses. It is ignored in requests.

templateobjectOptional

Information about a project in the current user’s hub that is configured as a template from which to copy products and settings when creating a new project:

If you include this object in a POST accounts/:accountId/projects request, the cloned project’s products and settings will match those of the template project.
If you omit this object from a POST accounts/:accountId/projects request, all of the current Forma hub’s products are added to the cloned project and activated.

Response headers

RateLimit-Remaininginteger

The number of requests remaining in the current rate-limit window.

RateLimit-Valueinteger

The maximum number of requests that the server is willing to accept during the current full minute

Request-IdstringOptional

Unique id for the request which can be provided when reporting issues to assist in facilitating improved research.

Response-TimestringOptional

Time taken to generate response.

Response

The project update has been received but not yet completed. The response includes only the fields being updated.

idstringOptionalRead-onlyformat: "uuid"

The internally generated ID for the project.

namestringOptional<=255 characters

The name of the project.

startDatedate or nullOptional

The estimated start date for the project, in ISO 8601 format.

endDatedate or nullOptional

The estimated end date for the project, in ISO 8601 format.

typestringOptional<=255 characters

The type of the project. Any value is accepted, but the following are recommended:

classificationenumOptionalDefaults to production

The classification of the project. Possible values:

production – Standard project.
template – A project that serves as a template for creating new projects.
component – A placeholder project containing reusable components (e.g., forms). Only one component project is allowed per hub. Known as a library in the Forma UI.
sample – A single sample project automatically created for Forma trials (limited to one per hub).

Allowed values:

projectValueobjectOptional

Contains details about the estimated cost of the project, including the amount (value) and the currency (currency).

statusenumOptionalDefaults to active

The status of the project.

Possible values: active, pending, archived and suspended.

Allowed values:

jobNumberstringOptional<=100 characters

A user-defined identifier for the project. This value is assigned when the project is created and can be used to filter projects. It supports partial matches when used with filterTextMatch.

addressLine1string or nullOptional<=255 characters

The first line of the project’s address.

addressLine2string or nullOptional<=255 characters

Additional address details for the project location.

citystring or nullOptional<=255 characters

The city wher the project is located.

stateOrProvincestring or nullOptional<=255 characters

The state or province where the project is located. It must be a valid name or an ISO 3166-2 code. The provided state or province must exist in the country of the project.

postalCodestring or nullOptional<=255 characters

The postal or ZIP code of the project location.

countrystring or nullOptional<=255 characters

The country where the project is located, using an ISO 3166-1 alpha-2 code.

latitudestring or nullOptional<=25 characters

The latitude coordinate of the project location.

longitudestring or nullOptional<=25 characters

The longitude coordinate of the project location.

timezoneenum or nullOptional

The time zone where the project is located. It must be a valid IANA time zone name from the IANA Time Zone Database (e.g., America/New_York). If no time zone is set, this field may be null.

constructionTypestringOptional

The type of construction for the project. Recommended values: New Construction, Renovation. Any value is accepted.

deliveryMethodstringOptional

The method used to deliver the project. Recommended values include Design-Bid-Build, Construction Management (CM) at Risk, and Integrated Project Delivery (IPD). Any value is accepted.

contractTypestringOptional

The type of contract for the project. For example, Lump Sum, Cost Plus, Guaranteed Maximum Price, Unit Price. Any value is accepted.

currentPhasestringOptional

Any value is accepted.

imageUrlstringOptionalRead-only<=255 characters

The URL of the main image associated with the project. This field can be null.

thumbnailImageUrlstringOptionalRead-only<=255 characters

The URL of the project’s thumbnail image. This field can be null.

createdAtdatetimeOptionalRead-only

The timestamp when the project was created, in ISO 8601 format. This value is set at creation and does not change.

updatedAtdatetimeOptionalRead-only

The timestamp when the project was last updated, in ISO 8601 format. This reflects changes to project fields but not updates to resources within the project.

accountIdstringOptionalRead-onlyformat: "uuid"

The hub ID associated with the project.

sheetCountinteger or nullOptional

The total number of sheets associated with the project.

Note that this field is relevant only in responses. It is ignored in requests.

platformenumOptionalDefaults to acc

The APS platform where the project is stored. Possible values: acc, bim360.

Note that this field is relevant only in responses. It is ignored in requests.

Allowed values:

businessUnitIdstringOptionalformat: "uuid"

The ID of the business unit that the project is associated with.

lastSignIndatetimeOptionalRead-only

The timestamp of the last time someone signed into the project.

memberGroupIdstringOptionalRead-only<=25 characters

Not relevant

adminGroupIdstringOptionalRead-only<=25 characters

Not relevant

productslist of objectsOptional

An array of the product objects associated with the project.

Note that this array is relevant only in responses. It is ignored in requests.

companyCountintegerOptional

The total number of companies associated with the project.

Note that this field is relevant only in responses. It is ignored in requests.

memberCountintegerOptional

The total number of members on the project.

Note that this field is relevant only in responses. It is ignored in requests.

templateIdstringOptionalRead-onlyformat: "uuid"

The ID of the project that was used as a template to create this project.

personalWorkspaceDetailsobjectOptionalRead-only

Details about the personal workspace designation. Present only on personal workspace projects; the property is absent on standard projects.

jobIdstringOptionalformat: "uuid"

Not relevant - we don’t currently support this field.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

410

Gone Error

415

Unsupported Media Type Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error