projects/{projectId}/packages
Retrieve all the packages for the specified project. For information about packages, see the Help documentation.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/construction/submittals/v2/projects/:projectId/packages |
Authentication Context | user context required |
Required OAuth Scopes | data:read |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via a three-legged OAuth flow. |
Request
URI Parameters
projectId string: UUID | The ID of the project.
Use the Data Management API to retrieve the project ID. For more information, see the Retrieve a Project ID tutorial. You need to convert the project ID into a project ID for the ACC API by removing the “b." prefix. For example, a project ID of b.a4be0c34a-4ab7 translates to a project ID of a4be0c34a-4ab7. |
Request
Query String Parameters
limit int | The number of results to return per page in the response payload. Possible values: 1 - 50 . Default value: 20 . For example, to limit the response to two results per page, use limit=2 . |
offset int | The page number from which you want to begin results; for example, offset=20 . For more details, see the JSON API Paging documentation. |
sort string | Sort packages by specified fields. Separate multiple values with commas. To sort in descending or ascending order, add desc or asc after the sort criteria. For example, spec asc .
Possible values: |
filter[identifier] string | Filter packages with the specified package ID (the package ID in the UI). You can specify multiple values. Separate multiple values with commas. For example, filter[identifier]=2 . |
filter[title] string | Filter packages with the specified title. You can specify multiple values. Separate multiple values with commas. For example, filter[title]=Structural Steel . |
filter[specId] string | Filter packages with the associated specified spec section internal, globally unique ID (UUID). You can specify multiple values. Separate multiple values with commas. For example, filter[specId]=b4aa3864-5706-4a7b-b06c-a792e8b2df23 . |
filter[spec.identifier] string | Filter packages with the associated specified section ID (the spec section ID in the UI). You can specify multiple values. Separate multiple values with commas. For example, filter[identifier]=2 . |
search string | Search for packages by querying a specified string within specific fields (identifier , title , spec.identifier ), and retrieve the associated packages that match the search criteria. This includes packages where the string matches part of a field. For example, search=1 . |
Response
HTTP Status Code Summary
200 OK | Successful retrievel of packages |
400 Bad Request | The request could not be understood by the server due to malformed syntax or missing request headers. |
401 Unauthorized | Invalid Authorization header. Verify and try again. |
403 Forbidden | The user is not authorized to perform this action. |
404 Not Found | The specified resource was not found. |
500 Internal Server Error | An unexpected error occurred on the server while processing the request. |
Response
Body Structure (200)
pagination object | Pagination information. |
limit int | The maximum number of results to be displayed on each page. |
offset int | The number of results to skip before starting to display results on a page. |
totalResults int | The overall count of results available across all pages. |
previousUrl string | The URL to retrieve the preceding page of results, if applicable. Not returned on the first page of results. |
nextUrl string | The URL to retrieve the subsequent page of results, if available. If not included, this is the last page of data. |
results array: object | The list of packages. |
id string: UUID | The internal, globally unique identifier (UUID) for the package. |
specId string: UUID | The internal, globally unique identifier (UUID) of the spec associated with the package. |
title string | The title of the package. |
identifier int | The unique ID assigned to the package within the user interface (UI). |
description string | The description of the package. |
specIdentifier string | The unique ID of the spec assigned to the package in the user interface (UI), specific to each project. |
permittedActions array: object | A list of actions that the user is allowed to perform on the submittal item. |
id string | The ID of the action in the format type_of_object::action . For example, Item::retrieve . |
fields object | A mapping of field names to lists of possible values for each field. Note that an empty array indicates that there is no specific set of values for those fields. |
mandatoryFields array: string | Fields required to perform specific actions, such as creating or transitioning a submittal item. The required fields depend on the user’s role and the action.
For example, creating a submittal item in the |
transitions array: object | Possible state transitions for a submittal item.
A submittal item can be in one of the following states:
|
id string | The ID of the transition in the format from-state::to-state . For example, create::mgr-1 , mgr-1::mgr-2 , rev::void . |
name string | The descriptive name of the transition. For example, Create , Send to Manager , Send to void . |
stateFrom object | The starting state of the transition. |
id string | The unique ID of the starting state. For example, create , mgr-1 , rev . A rev (review ), refers to the state where a submittal item is undergoing revisions or is being reviewed. |
name string | The name of the starting state. For example, Create , Manager Review , Review . |
stateTo object | The target state of the transition. |
id string | The unique ID of the target state. For example, mgr-1 , mgr-2 , void . |
name string | The name of the target state. For example, Manager Review , Manager Final Review , Void . |
transitionFields array: string | Fields that are used in the transition. For example, [subcontractor , subcontractorType , watchers , responseId ]. |
mandatoryFields array: string | A list of required fields for the transition. For example, [responseId ]. |
actionId string | Not relevant |
Example
Successful retrievel of packages
Request
curl -v 'https://developer.api.autodesk.com/construction/submittals/v2/projects/9eae7d59-1469-4389-bfb2-4114e2ba5545/packages' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 10,
"offset": 100,
"totalResults": 25,
"previousUrl": "https://developer.api.autodesk.com/construction/submittals/v2/projects/9eae7d59-1469-4389-bfb2-4114e2ba5545/settings/mappings?offset=10&limit=100",
"nextUrl": null
},
"results": [
{
"id": "e8302552-fc5a-42ac-ba4b-e9de9760c356",
"specId": "e6111f96-8437-491e-a1ae-16fd53f0cbef",
"title": "my package1",
"identifier": 222,
"description": "Electrical specifications",
"specIdentifier": "A-500",
"permittedActions": [
{
"id": "Item::retrieve",
"fields": {},
"mandatoryFields": [
""
],
"transitions": [
{
"id": "rev::void",
"name": "Send to void",
"stateFrom": {
"id": "rev",
"name": "REV"
},
"stateTo": {
"id": "rev",
"name": "REV"
},
"transitionFields": [
"subcontractor",
"subcontractorType",
"watchers",
"responseId"
],
"mandatoryFields": [
"responseId"
],
"actionId": "ITEM_TRANSITION_REV_VOID"
}
]
}
]
}
]
}