projects/{projectId}
Retrieves a project specified by project ID. You can find the project ID by calling GET /accounts/{accountId}/projects and examining results.id
in the response.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/construction/admin/v1/projects/:projectId |
Authentication Context | user context optional |
Required OAuth Scopes | account:read |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via either a two-legged or three-legged OAuth flow. |
Accept-Language string | This header is not currently supported in the Account Admin API. |
Region string | The region to which your request should be routed. If not set, the request is routed automatically but may incur a small latency increase.
Possible values: |
User-Id string | 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 ACC ID ( Note that this header is required for Account Admin POST, PATCH, and DELETE endpoints if you want to use a 2-legged authentication context. This header is optional for Account Admin GET endpoints. |
Request
URI Parameters
projectId string: 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 ACC 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 . |
Request
Query String Parameters
fields array: string | A comma-separated list of the project fields to include in the response. Default value: all fields.
Possible values: |
Response
HTTP Status Code Summary
200 OK | The requested project. |
400 Bad Request | The request could not be understood by the server due to malformed syntax. |
401 Unauthorized | Request has not been applied because it lacks valid authentication credentials for the target resource. |
403 Forbidden | The server understood the request but refuses to authorize it. |
404 Not Found | The resource cannot be found. |
406 Not Acceptable | The server cannot produce a response matching the list of acceptable values defined in the request. |
409 Conflict | The request could not be completed due to a conflict with the current state of the resource. |
410 | Access to the target resource is no longer available. |
429 Too Many Requests | User has sent too many requests in a given amount of time. |
500 Internal Server Error | An unexpected error occurred on the server. |
503 Service Unavailable | Server is not ready to handle the request. |
Response
Body Structure (200)
id string: UUID | The internally generated ID for the project. |
name string | The name of the project.
Max length: 255 |
startDate null,string | The estimated start date for the project, in ISO 8601 format. |
endDate null,string | The estimated end date for the project, in ISO 8601 format. |
type string | The type of the project. Following is a list of recommended values; however, any value is accepted.
Possible values: Max length: 255 |
classification enum:string | The project’s purpose. Possible values:
|
projectValue object | The value of the project. When updating the project value, both the value and currency parameters are required. |
value number | The estimated value or cost of the project based on the currency specified in the currency field. The default value is 0 . |
currency enum:string | The currency of the project value for the project. Default value: USD.
Possible values: AED , AFN , ALL , AMD , ANG , AOA , ARS , AUD , AWG , AZN , BAM , BBD , BDT , BGN , BHD , BIF , BMD , BND , BOB , BOV , BRL , BSD , BTN , BWP , BYN , BYR , BZD , CAD , CDF , CHE , CHF , CHW , CLF , CLP , CNY , COP , COU , CRC , CUC , CUP , CVE , CZK , DJF , DKK , DOP , DZD , EEK , EGP , ERN , ETB , EUR , FJD , FKP , GBP , GEL , GHS , GIP , GMD , GNF , GTQ , GYD , HKD , HNL , HRK , HTG , HUF , IDR , ILS , INR , IQD , IRR , ISK , JMD , JOD , JPY , KES , KGS , KHR , KMF , KPW , KRW , KWD , KYD , KZT , LAK , LBP , LKR , LRD , LSL , LTL , LVL , LYD , MAD , MDL , MGA , MKD , MMK , MNT , MOP , MRU , MUR , MVR , MWK , MXN , MXV , MYR , MZN , NAD , NGN , NIO , NOK , NPR , NZD , OMR , PAB , PEN , PGK , PHP , PKR , PLN , PYG , QAR , RON , RSD , RUB , RWF , SAR , SBD , SCR , SDG , SEK , SGD , SHP , SLE , SLL , SOS , SRD , SSP , STN , SVC , SYP , SZL , THB , TJS , TMT , TND , TOP , TRL , TRY , TTD , TWD , TZS , UAH , UGX , USD , USN , UYI , UYU , UYW , UZS , VED , VES , VND , VUV , WST , XAF , XAG , XAU , XBA , XBB , XBC , XBD , XCD , XDR , XOF , XPD , XPF , XPT , XSU , XTS , XUA , XXX , YER , ZAR , ZMW , ZWL |
status enum:string | The status of the project.
Possible values: |
jobNumber string | A job identifier that’s defined for the project by the user. This ID was defined when the project was created.
Max length: 100 |
addressLine1 null,string | Address line 1 for the project.
Max length: 255 |
addressLine2 null,string | Address line 2 for the project.
Max length: 255 |
city null,string | The city in which the project is located.
Max length: 255 |
stateOrProvince null,string | The state or province in which the project is located. Only valid state/province names and ISO 3166-1 alpha-2 codes is accepted. The provided state or province must exist in the country of the project.
Max length: 255 |
postalCode null,string | The zip or postal code in which the project is located.
Max length: 255 |
country null,string | The country in which the project is located. Only valid country names and ISO 3166-1 alpha-2 codes is accepted.
Max length: 255 |
latitude null,string | The latitude of the location of the project.
Max length: 25 |
longitude null,string | The longitude of the location of the project.
Max length: 25 |
timezone null,string | The time zone in which the project is located. Note that this field can be NULL.
Possible values: Pacific/Honolulu , America/Juneau , America/Los_Angeles , America/Phoenix , America/Denver , America/Chicago , America/New_York , America/Indiana/Indianapolis , Pacific/Pago_Pago , Pacific/Midway , America/Tijuana , America/Chihuahua , America/Mazatlan , America/Guatemala , America/Mexico_City , America/Monterrey , America/Regina , America/Bogota , America/Lima , America/Caracas , America/Halifax , America/Guyana , America/La_Paz , America/Santiago , America/St_Johns , America/Sao_Paulo , America/Argentina/Buenos_Aires , America/Godthab , Atlantic/South_Georgia , Atlantic/Azores , Atlantic/Cape_Verde , Africa/Casablanca , Europe/Dublin , Europe/Lisbon , Europe/London , Africa/Monrovia , Etc/UTC , Europe/Amsterdam , Europe/Belgrade , Europe/Berlin , Europe/Bratislava , Europe/Brussels , Europe/Budapest , Europe/Copenhagen , Europe/Ljubljana , Europe/Madrid , Europe/Paris , Europe/Prague , Europe/Rome , Europe/Sarajevo , Europe/Skopje , Europe/Stockholm , Europe/Vienna , Europe/Warsaw , Africa/Algiers , Europe/Zagreb , Europe/Athens , Europe/Bucharest , Africa/Cairo , Africa/Harare , Europe/Helsinki , Europe/Istanbul , Asia/Jerusalem , Europe/Kiev , Africa/Johannesburg , Europe/Riga , Europe/Sofia , Europe/Tallinn , Europe/Vilnius , Asia/Baghdad , Asia/Kuwait , Europe/Minsk , Africa/Nairobi , Asia/Riyadh , Asia/Tehran , Asia/Muscat , Asia/Baku , Europe/Moscow , Asia/Tbilisi , Asia/Yerevan , Asia/Kabul , Asia/Karachi , Asia/Tashkent , Asia/Kolkata , Asia/Colombo , Asia/Kathmandu , Asia/Almaty , Asia/Dhaka , Asia/Yekaterinburg , Asia/Rangoon , Asia/Bangkok , Asia/Jakarta , Asia/Novosibirsk , Asia/Shanghai , Asia/Chongqing , Asia/Hong_Kong , Asia/Krasnoyarsk , Asia/Kuala_Lumpur , Australia/Perth , Asia/Singapore , Asia/Taipei , Asia/Ulaanbaatar , Asia/Urumqi , Asia/Irkutsk , Asia/Tokyo , Asia/Seoul , Australia/Adelaide , Australia/Darwin , Australia/Brisbane , Australia/Melbourne , Pacific/Guam , Australia/Hobart , Pacific/Port_Moresby , Australia/Sydney , Asia/Yakutsk , Pacific/Noumea , Asia/Vladivostok , Pacific/Auckland , Pacific/Fiji , Asia/Kamchatka , Asia/Magadan , Pacific/Majuro , Pacific/Guadalcanal , Pacific/Tongatapu , Pacific/Apia , Pacific/Fakaofo |
constructionType string | The construction type of the project. Following is a list of recommended values; however, any value is accepted.
Possible values: |
deliveryMethod string | The delivery method of the project. Following is a list of recommended values; however, any value is accepted.
Possible values: |
contractType string | The contract type of the project. Following is a list of recommended values; however, any value is accepted.
Possible values: |
currentPhase string | The current phase of the project. Following is a list of recommended values; however, any value is accepted.
Possible values: |
businessUnitId string: UUID | The ID of the business unit that the project is associated with. |
lastSignIn datetime: ISO 8601 | The timestamp of the last time someone signed into the project. |
imageUrl string | The URL of the project image.
Max length: 255 |
thumbnailImageUrl string | The URL of the project thumbnail image.
Max length: 255 |
createdAt datetime: ISO 8601 | The timestamp when the project was created, in ISO 8601 format. |
updatedAt datetime: ISO 8601 | The timestamp when the project was last updated, in ISO 8601 format. This reflects only changes to the project fields and not changes to any resources in the project. |
memberGroupId string | Not relevant
Max length: 25 |
adminGroupId string | Not relevant
Max length: 25 |
accountId string: UUID | The ID of the account the project is associated with. |
sheetCount null,integer | The total number of sheets associated with the project.
Note that this field is relevant only in responses. It is ignored in requests. |
products array | 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 account 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. |
platform enum:string | The APS platform that the project belongs to.
Note that this field is relevant only in responses. It is ignored in requests.
Possible values: |
companyCount int | The total number of companies associated with the project.
Note that this field is relevant only in responses. It is ignored in requests. |
memberCount int | The total number of members on the project.
Note that this field is relevant only in responses. It is ignored in requests. |
Example
The requested project.
Request
curl -v 'https://developer.api.autodesk.com/construction/admin/v1/projects/367d5cc2-9008-462c-96e5-c9491db85d93?fields=name,platform' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"id": "3e354e66-ac8b-41dd-9bc1-93fc182c25dd",
"name": "Sample Project",
"startDate": "2010-01-01",
"endDate": "2015-12-31",
"type": "Hospital",
"classification": "production",
"projectValue": {
"value": 1650000,
"currency": "USD"
},
"status": "active",
"jobNumber": "HP-0002",
"addressLine1": "123 Main Street",
"addressLine2": "Suite 2",
"city": "San Francisco",
"stateOrProvince": "California",
"postalCode": "94001",
"country": "United States",
"latitude": "37.773972",
"longitude": "-122.431297",
"timezone": "America/Los_Angeles",
"constructionType": "New Construction",
"deliveryMethod": "Design-Bid",
"contractType": "Unit Price",
"currentPhase": "Design",
"businessUnitId": "802a4a61-3507-4d4e-8e3c-242a31cc0549",
"lastSignIn": "2019-01-01T12:45:00.000Z",
"imageUrl": "https://s3.us-east-1.amazonaws.com/project_image.png",
"thumbnailImageUrl": "https://s3.us-east-1.amazonaws.com/project_thumbnail_image.png",
"createdAt": "2018-01-01T12:45:00.000Z",
"updatedAt": "2019-01-01T12:45:00.000Z",
"memberGroupId": "3456542",
"adminGroupId": "3456543",
"accountId": "d73fc742-4538-401c-8d0f-853b49b750b2",
"sheetCount": 512,
"products": [
{
"key": "docs",
"status": "active",
"icon": "https://bim360-ea-ue1-prod-storage.s3.amazonaws.com/products/docs.svg",
"name": "Docs"
},
{
"key": "designCollaboration",
"status": "activating",
"icon": "https://bim360-ea-ue1-prod-storage.s3.amazonaws.com/products/dc.svg",
"name": "Design Collaboration"
},
{
"key": "modelCoordination",
"status": "activating",
"icon": "https://bim360-ea-ue1-prod-storage.s3.amazonaws.com/products/model.svg",
"name": "Model Coordination"
},
{
"key": "takeoff",
"status": "activating",
"icon": "https://bim360-ea-ue1-prod-storage.s3.amazonaws.com/products/quantify.svg",
"name": "Takeoff"
},
{
"key": "autoSpecs",
"status": "activating",
"icon": "https://bim360-ea-ue1-prod-storage.s3.amazonaws.com/tools/autospecs.svg",
"name": "AutoSpecs"
},
{
"key": "build",
"status": "activating",
"icon": "https://bim360-ea-ue1-prod-storage.s3.amazonaws.com/products/build.svg",
"name": "Build"
},
{
"key": "cost",
"status": "activating",
"icon": "https://bim360-ea-ue1-prod-storage.s3.amazonaws.com/products/cost.svg",
"name": "Cost Management"
},
{
"key": "insight",
"status": "activating",
"icon": "https://bim360-ea-ue1-prod-storage.s3.amazonaws.com/products/insight.svg",
"name": "Insight"
},
{
"key": "projectAdministration",
"status": "activating",
"icon": "https://bim360-ea-ue1-prod-storage.s3.amazonaws.com/tools/settings.svg",
"name": "Project Admin"
},
{
"key": "accountAdministration",
"status": "activating",
"icon": "hhttps://bim360-ea-ue1-prod-storage.s3.amazonaws.com/tools/settings.svg",
"name": "Account Admin"
}
],
"platform": "acc",
"companyCount": 10,
"memberCount": 100
}