openapi: 3.0.1 info: title: Data Management version: '1.0' description: |- The Data Management API provides a unified and consistent way to access data across BIM 360 Team, Fusion Team (formerly known as A360 Team), BIM 360 Docs, A360 Personal, and the Object Storage Service. With this API, you can accomplish a number of workflows, including accessing a Fusion model in Fusion Team and getting an ordered structure of items, IDs, and properties for generating a bill of materials in a 3rd-party process. Or, you might want to superimpose a Fusion model and a building model to use in the Viewer. termsOfService: 'https://www.autodesk.com/company/legal-notices-trademarks/terms-of-service-autodesk360-web-services/forge-platform-web-services-api-terms-of-service' x-support: 'https://stackoverflow.com/questions/tagged/autodesk-data-management' contact: name: Autodesk Plaform Services url: 'https://aps.autodesk.com/' email: aps.help@autodesk.com servers: - description: Project Prod Server url: 'https://developer.api.autodesk.com' paths: /project/v1/hubs: parameters: [] get: tags: - Hubs operationId: getHubs summary: List Hubs description: |- Returns a collection of hubs that the user of your app can access. The returned hubs can be BIM 360 Team hubs, Fusion Team hubs (formerly known as A360 Team hubs), A360 Personal hubs, ACC Docs (Autodesk Docs) accounts, or BIM 360 Docs accounts. Only active hubs are returned. For 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``. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' - $ref: '#/components/parameters/filter_id' - $ref: '#/components/parameters/filter_name' - $ref: '#/components/parameters/filter_extension_type' responses: '200': description: The list of hubs was successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/Hubs' '401': $ref: '#/components/responses/401-general' '403': $ref: '#/components/responses/403-general' '/project/v1/hubs/{hub_id}': parameters: - $ref: '#/components/parameters/hub_id' get: tags: - Hubs operationId: getHub summary: Get a Hub description: |- Returns the hub specified by the ``hub_id`` parameter. For 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``. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' responses: '200': description: The hub was successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/Hub' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '/project/v1/hubs/{hub_id}/projects': get: tags: - Projects operationId: getHubProjects summary: Get Projects description: |- 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. For 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``. Similarly, to convert a BIM 360 and ACC project IDs to Data Management project IDs prefix the BIM 360 or ACC Project ID with ``b.``. For example, a project ID of ``c8b0c73d-3ae9`` translates to a project ID of ``b.c8b0c73d-3ae9``. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' - $ref: '#/components/parameters/filter_id' - $ref: '#/components/parameters/filter_extension_type' - $ref: '#/components/parameters/page_number' - $ref: '#/components/parameters/page_limit' responses: '200': description: 'The list of projects was successfully retrieved. ' content: application/json: schema: $ref: '#/components/schemas/Projects' '400': $ref: '#/components/responses/400-general' '401': $ref: '#/components/responses/401-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' parameters: - $ref: '#/components/parameters/hub_id' '/project/v1/hubs/{hub_id}/projects/{project_id}': get: tags: - Projects operationId: getProject summary: Get a Project description: |- Returns the specified project from within the specified hub. For 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``. Similarly, 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 ``b.c8b0c73d-3ae9``. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' responses: '200': description: The project was successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/Project' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' parameters: - $ref: '#/components/parameters/hub_id' - $ref: '#/components/parameters/project_id' '/project/v1/hubs/{hub_id}/projects/{project_id}/hub': get: tags: - Projects operationId: getProjectHub summary: Get Hub for Project description: |- Returns the hub that contains the project specified by the ``project_id`` parameter. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' responses: '200': description: Information about the hub was successfully returned. content: application/json: schema: $ref: '#/components/schemas/Hub' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' parameters: - $ref: '#/components/parameters/hub_id' - $ref: '#/components/parameters/project_id' '/project/v1/hubs/{hub_id}/projects/{project_id}/topFolders': get: tags: - Projects operationId: getProjectTopFolders summary: List Top-level Project Folders description: |- 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. If 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. Users with access permission to a folder has access permission to all its subfolders. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' - $ref: '#/components/parameters/excludeDeleted' - $ref: '#/components/parameters/projectFilesOnly' responses: '200': description: The top-level folders of the specified project were returned successfully. content: application/json: schema: $ref: '#/components/schemas/TopFolders' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' parameters: - $ref: '#/components/parameters/hub_id' - $ref: '#/components/parameters/project_id' '/data/v1/projects/{project_id}/folders/{folder_id}': get: tags: - Folders operationId: getFolder summary: Get a Folder description: |- Returns the folder specified by the ``folder_id`` parameter from within the project identified by the ``project_id`` parameter. All folders and subfolders within a project (including the root folder) have a unique ID. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/If-Modified-Since' - $ref: '#/components/parameters/x-user-id' responses: '200': description: The specified folder was successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/Folder' '304': $ref: '#/components/responses/304-general' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' patch: tags: - Folders operationId: patchFolder summary: Modify a Folder description: |- Renames, moves, hides, or unhides a folder. Marking a BIM 360 Docs folder as hidden effectively deletes it. You can restore it by changing its ``hidden`` attribute. You can also move BIM 360 Docs folders by changing their parent folder. You cannot permanently delete BIM 360 Docs folders. They are tagged as hidden folders and are removed from the BIM 360 Docs UI and from regular Data Management API responses. You can use the hidden filter (``filter[hidden]=true``) to get a list of deleted folders with the [List Folder Contents](/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-contents-GET/) operation. Before you use the Data Management API to access BIM 360 Docs folders, provision your app through the BIM 360 Account Administrator portal. For details, see the [Manage Access to Docs tutorial](/en/docs/bim360/v1/tutorials/getting-started/manage-access-to-docs/). **Note:** This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the [ACC Platform API documentation](/en.docs.acc.v1/overview/introduction/). security: - 2-legged: - 'data:write' - 3-legged: - 'data:write' parameters: - $ref: '#/components/parameters/x-user-id' responses: '200': description: The folder was successfully modified. content: application/json: schema: $ref: '#/components/schemas/Folder' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '423': $ref: '#/components/responses/423-general' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/ModifyFolderPayload' description: Describe the folder to be patched. x-folder-id: projects-project_id-folders-folder_id-PATCH parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/folder_id' '/data/v1/projects/{project_id}/folders/{folder_id}/parent': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/folder_id' get: tags: - Folders operationId: getFolderParent summary: Get Parent of a Folder description: |- Returns the parent folder of the specified folder. In a project, folders are organized in a hierarchy. Each folder except for the root folder has a parent folder. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' responses: '200': description: The parent folder was retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/Folder' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' x-folder-id: projects-project_id-folders-folder_id-parent-GET '/data/v1/projects/{project_id}/folders/{folder_id}/contents': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/folder_id' get: tags: - Folders operationId: getFolderContents summary: List Folder Contents description: |- Returns a list of items and folders within the specified folder. Items represent word documents, fusion design files, drawings, spreadsheets, etc. The resources contained in the ``included`` array of the response are their tip versions. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' - $ref: '#/components/parameters/filter_type' - $ref: '#/components/parameters/filter_id' - $ref: '#/components/parameters/filter_extension_type' - $ref: '#/components/parameters/filter_lastModifiedTimeRollup' - $ref: '#/components/parameters/page_number' - $ref: '#/components/parameters/page_limit' - $ref: '#/components/parameters/includeHidden' responses: '200': description: The content of the specified folder was successfully returned. content: application/json: schema: $ref: '#/components/schemas/FolderContents' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '/data/v1/projects/{project_id}/folders/{folder_id}/refs': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/folder_id' get: tags: - Folders operationId: getFolderRefs summary: List Related Resources for a Folder description: |- Returns the resources (items, folders, and versions) that have a custom relationship with the specified folder. Custom relationships can be established between a folder and other resources within the data domain service (folders, items, and versions). Each relationship is defined by the id of the object at the other end of the relationship, together with type, attributes, and relationships links. Callers will typically use a filter parameter to restrict the response to the custom relationship types (``filter[meta.refType]``) they are interested in. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' - $ref: '#/components/parameters/filter_type_version' - $ref: '#/components/parameters/filter_id' - $ref: '#/components/parameters/filter_extension_type' responses: '200': description: The list of related resources was retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/FolderRefs' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '/data/v1/projects/{project_id}/folders/{folder_id}/search': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/folder_id' get: tags: - Folders operationId: getFolderSearch summary: List Folder and Subfolder Contents description: |- Searches the specified folder and its subfolders and returns a list of the latest versions of the items you can access. Use the ``filter`` query string parameter to narrow down the list as appropriate. You can filter by the following properties of the version payload: - ``type`` property, - ``id`` property, - any of the attributes object properties. For example, you can filter by ``createTime`` and ``mimeType``. It returns tip versions (latest versions) of properties where the filter conditions are satisfied. To verify the properties of the attributes object for a specific version, use the [Get a Version](/en/docs/data/v2/reference/http/projects-project_id-versions-version_id-GET/) operation. To list the immediate contents of the folder without parsing subfolders, use the [List Folder Contents](/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-contents-GET/) operation. **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/). security: - 3-legged: - 'data:read' - 'data:search' parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/page_number' responses: '200': description: 'The contents of the folder and its subfolders were successfully returned. ' content: application/json: schema: $ref: '#/components/schemas/Search' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '/data/v1/projects/{project_id}/folders/{folder_id}/relationships/refs': parameters: - $ref: '#/components/parameters/folder_id' - $ref: '#/components/parameters/project_id' get: tags: - Folders operationId: getFolderRelationshipsRefs summary: List Custom Relationships for a Folder description: |- Returns the custom relationships associated with the specified folder. Custom relationships can be established between a folder and other resources within the data domain service (folders, items, and versions). Each relationship is defined by the ID of the object at the other end of the relationship, together with type, specific reference meta including extension data. Callers will typically use a filter parameter to restrict the response to the custom relationship types (``filter[meta.refType]``) they are interested in. The response body will have an included array that contains the resources in the relationship, which is essentially what is returned by the [List Related Resources for a Folder](/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-refs-GET/) operation. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' - $ref: '#/components/parameters/filter_type_version' - $ref: '#/components/parameters/filter_id' - $ref: '#/components/parameters/filter_refType' - $ref: '#/components/parameters/filter_direction' - $ref: '#/components/parameters/filter_extension_type' responses: '200': description: The list of custom relationships was successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/RelationshipRefs' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' post: tags: - Folders operationId: createFolderRelationshipsRef summary: Create a Custom Relationship for a Folder description: 'Creates a custom relationship between a folder and another resource within the data domain service (folder, item, or version).' security: - 2-legged: - 'data:create' - 3-legged: - 'data:create' parameters: - $ref: '#/components/parameters/x-user-id' responses: '204': description: The reference between resources was successfully created. '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/RelationshipRefsPayload' description: '' '/data/v1/projects/{project_id}/folders/{folder_id}/relationships/links': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/folder_id' get: tags: - Folders operationId: getFolderRelationshipsLinks summary: List Relationship Links for a Folder description: |- Returns a list of links for the specified folder. Custom relationships can be established between a folder and other external resources residing outside the data domain service. A link’s ``href`` attribute defines the target URI to access a resource. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' responses: '200': description: Successful retrieval of the links collection associated with a specific resource. content: application/json: schema: $ref: '#/components/schemas/RelationshipLinks' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '/data/v1/projects/{project_id}/items/{item_id}': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/item_id' get: tags: - Items operationId: getItem summary: Get an Item description: |- Retrieves an item. Items represent Word documents, Fusion 360 design files, drawings, spreadsheets, etc. The tip version for the item is included in the included array of the payload. To retrieve multiple items, see the ListItems command. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' - $ref: '#/components/parameters/includePathInProject' responses: '200': description: The specified item was retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/Item' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' patch: tags: - Items operationId: patchItem summary: Update an Item description: |- Updates the ``displayName`` of the specified item. Note that updating the ``displayName`` of an item is not supported for BIM 360 Docs or ACC items. **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/). parameters: - $ref: '#/components/parameters/x-user-id' responses: '200': description: Updated the item’s properties successfully. content: application/json: schema: $ref: '#/components/schemas/Item' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '423': $ref: '#/components/responses/423-general' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/ModifyItemPayload' description: Describe the item to be patched. security: - 2-legged: - 'data:write' - 3-legged: - 'data:write' '/data/v1/projects/{project_id}/items/{item_id}/parent': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/item_id' get: tags: - Items operationId: getItemParentFolder summary: Get Parent of an Item description: |- Returns the parent folder of the specified item. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' responses: '200': description: The parent folder was retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/Folder' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '/data/v1/projects/{project_id}/items/{item_id}/relationships/refs': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/item_id' get: tags: - Items operationId: getItemRelationshipsRefs summary: List Custom Relationships for an Item description: |- Returns the custom relationships that are associated with the specified item. Custom relationships can be established between an item and other resources within the ``data`` domain service (folders, items, and versions). Each relationship is defined by the ID of the object at the other end of the relationship, together with type, specific reference meta including extension data. Callers will typically use a filter parameter to restrict the response to the custom relationship types (``filter[meta.refType]``) they are interested in. The response body will have an included array that contains the resources in the relationship, which is essentially what is returned by the [List Related Resources for an Item](/en/docs/data/v2/reference/http/projects-project_id-items-item_id-refs-GET/) operation. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' - $ref: '#/components/parameters/filter_type_version' - $ref: '#/components/parameters/filter_id' - $ref: '#/components/parameters/filter_refType' - $ref: '#/components/parameters/filter_direction' - $ref: '#/components/parameters/filter_extension_type' responses: '200': description: The list of custom relationships was successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/RelationshipRefs' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' post: tags: - Items operationId: createItemRelationshipsRef summary: Create a Custom Relationship for an Item description: 'Creates a custom relationship between an item and another resource within the data domain service (folder, item, or version).' security: - 2-legged: - 'data:create' - 3-legged: - 'data:create' parameters: - $ref: '#/components/parameters/x-user-id' responses: '204': description: A custom relationship for the item was successfully created. '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/RelationshipRefsPayload' description: '' '/data/v1/projects/{project_id}/items/{item_id}/refs': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/item_id' get: tags: - Items operationId: getItemRefs summary: List Related Resources for an Item description: |- Returns the resources (items, folders, and versions) that have a custom relationship with the specified item. Custom relationships can be established between an item and other resources within the data domain service (folders, items, and versions). Each relationship is defined by the ID of the object at the other end of the relationship, together with type, attributes, and relationships links. Callers will typically use a filter parameter to restrict the response to the custom relationship types (``filter[meta.refType]``) they are interested in. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' - $ref: '#/components/parameters/filter_type_version' - $ref: '#/components/parameters/filter_id' - $ref: '#/components/parameters/filter_extension_type' responses: '200': description: The list of related resources was successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/Refs' '400': $ref: '#/components/responses/400-general' '403': description: Forbidden '404': $ref: '#/components/responses/404-general' '/data/v1/projects/{project_id}/items/{item_id}/relationships/links': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/item_id' get: tags: - Items operationId: getItemRelationshipsLinks summary: List Relationship Links for an Item description: |- Returns a list of links for the specified item. Custom relationships can be established between an item and other external resources residing outside the data domain service. A link’s ``href`` attribute defines the target URI to access a resource. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' responses: '200': description: The relationship links for the item were retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/RelationshipLinks' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '/data/v1/projects/{project_id}/items/{item_id}/tip': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/item_id' get: tags: - Items operationId: getItemTip summary: Get Tip Version of an Item description: |- Returns the latest version of the specified item. A project can contain multiple versions of a resource item. The latest version is referred to as the tip version, which is returned by this operation. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' responses: '200': description: The tip version of the item was retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/ItemTip' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '/data/v1/projects/{project_id}/items/{item_id}/versions': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/item_id' get: tags: - Items operationId: getItemVersions summary: List all Versions of an Item description: |- Lists all versions of the specified item. A project can contain multiple versions of a resource item. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' - $ref: '#/components/parameters/filter_id' - $ref: '#/components/parameters/filter_extension_type' - $ref: '#/components/parameters/filter_versionNumber' - $ref: '#/components/parameters/page_number' - $ref: '#/components/parameters/page_limit' responses: '200': description: All versions of the specified item were successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/Versions' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '/data/v1/projects/{project_id}/versions/{version_id}': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/version_id' get: tags: - Versions operationId: getVersion summary: Get a Version description: |- Returns the specified version of an item. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' responses: '200': description: The specified version was retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/Version' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' patch: tags: - Versions operationId: patchVersion summary: Update a Version description: | Updates the properties of the specified version of an item. Currently, you can only change the name of the version. **Note:** This operation is not supported for BIM 360 and ACC. If you want to rename a version, create a new version with a new name. security: - 2-legged: - 'data:write' - 3-legged: - 'data:write' responses: '200': description: The version was updated successfully. content: application/json: schema: $ref: '#/components/schemas/Version' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '423': $ref: '#/components/responses/423-general' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/ModifyVersionPayload' description: '' '/data/v1/projects/{project_id}/versions/{version_id}/item': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/version_id' get: tags: - Versions operationId: getVersionItem summary: Get Item by Version description: |- Returns the item corresponding to the specified version. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' responses: '200': description: Successful retrieval of a specific item. content: application/json: schema: $ref: '#/components/schemas/Item' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '/data/v1/projects/{project_id}/versions/{version_id}/refs': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/version_id' get: tags: - Versions operationId: getVersionRefs summary: List Related Resources for a Version description: |- Returns the resources (items, folders, and versions) that have a custom relationship with the specified version. Custom relationships can be established between a version of an item and other resources within the data domain service (folders, items, and versions). - Each relationship is defined by the id of the object at the other end of the relationship, together with type, attributes, and relationships links. - Callers will typically use a filter parameter to restrict the response to the custom relationship types (``filter[meta.refType]``) they are interested in. - The response body will have an included array that contains the ref resources that are involved in the relationship, which is essentially the response to the [List Custom Relationships for a Version](/en/docs/data/v2/reference/http/projects-project_id-versions-version_id-relationships-refs-GET/) operation. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' - $ref: '#/components/parameters/filter_type_version' - $ref: '#/components/parameters/filter_id' - $ref: '#/components/parameters/filter_extension_type' responses: '200': description: The list of resources was successfully returned. content: application/json: schema: $ref: '#/components/schemas/Refs' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '/data/v1/projects/{project_id}/versions/{version_id}/relationships/refs': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/version_id' get: tags: - Versions operationId: getVersionRelationshipsRefs summary: List Custom Relationships for a Version description: |- Returns the custom relationships for the specified version. Custom relationships can be established between a version of an item and other resources within the data domain service (folders, items, and versions). - Each relationship is defined by the id of the object at the other end of the relationship, together with type, specific reference meta including extension data. - Callers will typically use a filter parameter to restrict the response to the custom relationship types (``filter[meta.refType]``) they are interested in. - The response body will have an included array that contains the resources in the relationship, which is essentially the response to the [List Related Resources operation](/en/docs/data/v2/reference/http/projects-project_id-versions-version_id-relationships-refs-POST/). - To get custom relationships for multiple versions, see the ListRefs command. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' - $ref: '#/components/parameters/filter_type_version' - $ref: '#/components/parameters/filter_id' - $ref: '#/components/parameters/filter_refType' - $ref: '#/components/parameters/filter_direction' - $ref: '#/components/parameters/filter_extension_type' responses: '200': description: The custom relationships for the version was returned successfully. content: application/json: schema: $ref: '#/components/schemas/RelationshipRefs' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' post: tags: - Versions operationId: createVersionRelationshipsRef summary: Create a Custom Relationship for a Version description: 'Creates a custom relationship between a version of an item and another resource within the data domain service (folder, item, or version).' security: - 2-legged: - 'data:create' - 3-legged: - 'data:create' parameters: - $ref: '#/components/parameters/x-user-id' responses: '204': description: The custom relationship was successfully created. '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/RelationshipRefsPayload' description: '' '/projects/{project_id}/versions/{version_id}/relationships/links': get: tags: - Versions operationId: getVersionRelationshipsLinks summary: List Links for a Version description: |- Returns a collection of links for the specified version of an item. Custom relationships can be established between a version of an item and other external resources residing outside the data domain service. A link’s href defines the target URI to access the resource. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' responses: '200': description: Successful retrieval of the links collection associated with a specific resource.OK content: application/json: schema: $ref: '#/components/schemas/RelationshipLinks' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/version_id' '/data/v1/projects/{project_id}/storage': parameters: - $ref: '#/components/parameters/project_id' post: tags: - Projects operationId: createStorage summary: Create a Storage Location in OSS description: |- 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. **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/). security: - 2-legged: - 'data:create' - 3-legged: - 'data:create' parameters: - $ref: '#/components/parameters/x-user-id' responses: '201': description: The storage location was created successfully. content: application/json: schema: $ref: '#/components/schemas/Storage' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/StoragePayload' description: '' '/data/v1/projects/{project_id}/folders': parameters: - $ref: '#/components/parameters/project_id' post: tags: - Folders operationId: createFolder summary: Create a Folder description: |- Creates a new folder in the specified project. Use the ``parent`` attribute in the request body to specify where in the hierarchy the new folder should be located. Folders can be nested up to 25 levels deep. Use the `Modify a Folder `_ operation to delete and restore folders. Before you use the Data Management API to access BIM 360 Docs folders, provision your app through the BIM 360 Account Administrator portal. For details, see the [Manage Access to Docs tutorial](/en/docs/bim360/v1/tutorials/getting-started/manage-access-to-docs/). **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/). security: - 2-legged: - 'data:create' - 3-legged: - 'data:create' parameters: - $ref: '#/components/parameters/x-user-id' responses: '201': description: Successful creation of a folder. content: application/json: schema: $ref: '#/components/schemas/Folder' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '409': $ref: '#/components/responses/409-general' '423': $ref: '#/components/responses/423-general' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/FolderPayload' description: '' '/data/v1/projects/{project_id}/items': parameters: - $ref: '#/components/parameters/project_id' post: tags: - Items operationId: createItem summary: Create an Item description: |- Creates the first version of a file (item). To create additional versions of an item, use POST versions. Before you create the first version of an item, you must create a placeholder for the file, and upload the file to the placeholder. For more details about the workflow, see the tutorial on uploading a file. This operation also allows you to create a new item by copying a specific version of an existing item to another folder. The copied version becomes the first version of the new item in the target folder. **Note:** You cannot copy versions of items across different projects and accounts. Use the [Create Version](/en/docs/data/v2/reference/http/projects-project_id-versions-POST/) operation with the ``copyFrom`` parameter if you want to create a new version of an item by copying a specific version of another item. Before you use the Data Management API to access BIM 360 Docs files, you must provision your app through the BIM 360 Account Administrator portal. For details, see the [Manage Access to Docs tutorial](/en/docs/bim360/v1/tutorials/getting-started/manage-access-to-docs/). **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/). security: - 2-legged: - 'data:create' - 3-legged: - 'data:create' parameters: - $ref: '#/components/parameters/copyFrom' - schema: type: string in: query name: x-user-id description: | In a two-legged authentication context, the app has access to all users specified by the administrator in the SaaS integrations UI. By providing this header, the API call will be limited to act on behalf of only the user specified. Note that for a three-legged OAuth flow or for a two-legged OAuth flow with user impersonation (``x-user-id``), the users of your app must have permission to upload files to the specified parent folder (``data.attributes.relationships.parent.data.id``). For copying files, users of your app must have permission to view the source folder. For information about managing and verifying folder permissions for BIM 360 Docs, see the section on [Managing Folder Permissions](http://help.autodesk.com/view/BIM360D/ENU/?guid=GUID-2643FEEF-B48A-45A1-B354-797DAD628C37).' responses: '201': description: The first version of an item was successfully created. content: application/json: schema: $ref: '#/components/schemas/CreatedItem' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '409': $ref: '#/components/responses/409-general' '423': $ref: '#/components/responses/423-general' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/ItemPayload' description: '' '/data/v1/projects/{project_id}/versions': parameters: - $ref: '#/components/parameters/project_id' post: tags: - Versions operationId: createVersion summary: Create a Version description: |- Creates a new versions of an existing item. Before creating a new version you must create a storage location for the version in OSS, and upload the file to that location. For more details about the workflow, see the tutorial on uploading a file. This operation also allows you to create a new version of an item by copying a specific version of an existing item from another folder within the project. The new version becomes the tip version of the item. Use the [Create an Item](/en/docs/data/v2/reference/http/projects-project_id-items-POST/) operation to copy a specific version of an existing item as a new item in another folder. This operation can also be used to delete files on BIM360 Document Management. For more information, please refer to the delete and restore a file tutorial. Before you use the Data Management API to access BIM 360 Docs files, you must provision your app through the BIM 360 Account Administrator portal. For details, see the [Manage Access to Docs tutorial](/en/docs/bim360/v1/tutorials/getting-started/manage-access-to-docs/). **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/). security: - 2-legged: - 'data:create' - 3-legged: - 'data:create' parameters: - $ref: '#/components/parameters/x-user-id' - $ref: '#/components/parameters/copyFrom' responses: '201': description: Successful creation of a version. content: application/json: schema: $ref: '#/components/schemas/CreatedVersion' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '409': description: Conflict '423': $ref: '#/components/responses/423-general' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/VersionPayload' description: '' '/data/v1/projects/{project_id}/versions/{version_id}/downloadFormats': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/version_id' get: tags: - Versions operationId: getVersionDownloadFormats summary: List Supported Download Formats description: |- Returns a list of file formats the specified version of an item can be downloaded as. **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/). security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' responses: '200': description: The list of file formats that the version can be downloaded as was successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/DownloadFormats' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '/data/v1/projects/{project_id}/versions/{version_id}/downloads': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/version_id' get: tags: - Versions operationId: getVersionDownloads description: |- Returns the list of file formats of the specified version of an item currently available for download. **Note:** This operation is not fully implemented as yet. It currently returns an empty data object. summary: List Available Download Formats security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' - $ref: '#/components/parameters/filter_format_fileType' responses: '200': description: The list of available downloadformats was successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/Downloads' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '/data/v1/projects/{project_id}/downloads/{download_id}': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/download_id' get: tags: - Projects operationId: getDownload summary: Get Download Details description: | Returns the details of a downloadable format of a version of an item. security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' responses: '200': description: The details of the specified download were retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/Download' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '/data/v1/projects/{project_id}/downloads': parameters: - $ref: '#/components/parameters/project_id' post: tags: - Projects operationId: createDownload summary: Create Download description: | Kicks off a job to generate the specified download format of the version. Once the job completes, the specified format becomes available for download. security: - 2-legged: - 'data:create' - 3-legged: - 'data:create' parameters: - $ref: '#/components/parameters/x-user-id' responses: '202': description: A job to generate the download format was successfully started. content: application/json: schema: $ref: '#/components/schemas/CreatedDownload' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/DownloadPayload' description: '' '/data/v1/projects/{project_id}/jobs/{job_id}': parameters: - $ref: '#/components/parameters/project_id' - $ref: '#/components/parameters/job_id' get: tags: - Projects operationId: getDownloadJob summary: Check Download Creation Progress description: | Checks the status of a job that generates a downloadable format of a version of an item. **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. security: - 2-legged: - 'data:read' - 3-legged: - 'data:read' parameters: - $ref: '#/components/parameters/x-user-id' responses: '200': description: Details of the specified job was returned successfully. content: application/json: schema: $ref: '#/components/schemas/Job' '303': description: The request has been redirected to a new location. '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' '/data/v1/projects/{project_id}/commands': parameters: - $ref: '#/components/parameters/project_id' post: tags: - Commands operationId: executeCommand description: | Executes the command that you specify in the request body. Commands enable you to perform general operations on multiple resources. For example, you can check whether a user has permission to delete a collection of versions, items, and folders. The command as well as the input data for the command are specified using the ``data`` object of the request body. For more information about commands see the [Commands](/en/docs/data/v2/overview/commands/) section in the Developer's Guide. security: - 2-legged: - 'data:read' - 'data:create' - 'data:write' - 3-legged: - 'data:read' - 'data:create' - 'data:write' parameters: - $ref: '#/components/parameters/x-user-id' responses: '200': description: | The command was executed successfully. content: application/json: schema: $ref: '#/components/schemas/Command' '400': $ref: '#/components/responses/400-general' '403': $ref: '#/components/responses/403-general' '404': $ref: '#/components/responses/404-general' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/CommandPayload' description: The request body's ``data`` object defines the command to execute and contains any required input data. summary: Execute a Command components: securitySchemes: 3-legged: type: oauth2 flows: authorizationCode: authorizationUrl: 'https://developer.api.autodesk.com/authentication/v2/authorize' tokenUrl: 'https://developer.api.autodesk.com/authentication/v2/token' refreshUrl: 'https://developer.api.autodesk.com/authentication/v2/token' scopes: 'data:read': read your data 'data:write': modify your data 'data:create': create new data x-authentication_context: user context required description: User context required. 2-legged: type: oauth2 flows: clientCredentials: tokenUrl: 'https://developer.api.autodesk.com/authentication/v2/token' scopes: 'data:read': read application accessible data 'data:write': write application accessible data 'data:create': create application accessible data x-authentication_context: application context required description: Application context required. schemas: Hubs: description: Successful retrieval of the hubs collection. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: /project/v1/hubs data: - type: hubs id: a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjE attributes: name: my team hub extension: type: 'hubs:autodesk.core:Hub' version: '1.0' schema: href: /schema/v1/versions/hubs%3Aautodesk.core%3AHub-1.0 data: {} region: US links: self: href: /project/v1/hubs/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjE relationships: projects: links: related: href: /project/v1/hubs/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjE/projects pimCollection: data: type: collection id: co.d41d8cd00998ecf8427e - type: hubs id: a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjI= attributes: name: my personal hub extension: type: 'hubs:autodesk.a360:PersonalHub' version: '1.0' schema: href: /schema/v1/versions/hubs%3Aautodesk.a360%3APersonalHub-1.0 data: {} region: US links: self: href: /project/v1/hubs/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjI= relationships: projects: links: related: href: /project/v1/hubs/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjI=/projects pimCollection: data: type: collection id: co.368e3dc4144c0ff253d6 title: HubsResponse properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: type: array description: An array of objects where each object represents a hub. items: $ref: '#/components/schemas/HubData' Hub: description: An object representing a hub. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: /project/v1/hubs/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjE data: type: hubs id: a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjE attributes: name: my hub extension: data: {} version: '1.0' type: 'hubs:autodesk.core:Hub' schema: href: /schema/v1/versions/hubs%3Aautodesk.core%3AHub-1.0 region: US relationships: projects: links: related: href: /project/v1/hubs/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjE/projects pimCollection: data: type: collection id: co.d41d8cd00998ecf8427e links: self: href: /project/v1/hubs/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjE title: Hub properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: $ref: '#/components/schemas/HubData' HubData: title: HubData x-stoplight: id: nthprwqm1o6lv type: object description: The object containing information about the hub. properties: type: $ref: '#/components/schemas/type_hub' x-stoplight: id: tc7fa3ac13r6h id: type: string x-stoplight: id: 9f2ogpb91zghy description: 'The hub ID, which uniquely identifies the hub.' attributes: type: object x-stoplight: id: xjchsug8c2rw7 description: The properties of the hub. properties: name: type: string x-stoplight: id: vw18qagfrio57 description: A human friendly name to identify the hub. extension: $ref: '#/components/schemas/base_attributes_extension_object_with_schema_link' region: $ref: '#/components/schemas/region' x-stoplight: id: qy609yu6fbfsf relationships: type: object x-stoplight: id: 0skjm84h82gng description: Contains links to resources that are directly related to this hub. properties: projects: type: object x-stoplight: id: dj2kh2hqjxzuu description: |- Contains the endpoint you can use to list the projects in this hub. properties: links: $ref: '#/components/schemas/json_api_links_related' pimCollection: type: object x-stoplight: id: q1erud678lf5y description: Information on the ``id`` and ``type`` properties of a resource. This is available only for Fusion Team hubs and A360 Personal hubs. properties: data: $ref: '#/components/schemas/json_api_type_id' links: $ref: '#/components/schemas/json_api_links_self' required: - links Projects: description: An object representing a collection of projects within a hub. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: 'https://developer.api.autodesk.com/project/v1/hubs/b.622cb5d1-581b-4a46-a6d9-4ebc68ea4051/projects' data: - type: projects id: b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d attributes: name: my project scopes: - global extension: type: 'projects:autodesk.bim360:Project' version: '1.0' schema: href: 'https://developer.api.autodesk.com/schema/v1/versions/projects:autodesk.bim360:Project-1.0' data: projectType: BIM360 links: self: href: 'https://developer.api.autodesk.com/project/v1/hubs/b.622cb5d1-581b-4a46-a6d9-4ebc68ea4051/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d' webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d' relationships: hub: data: type: hubs id: b.622cb5d1-581b-4a46-a6d9-4ebc68ea4051 links: related: href: 'https://developer.api.autodesk.com/project/v1/hubs/b.622cb5d1-581b-4a46-a6d9-4ebc68ea4051' rootFolder: data: type: folders id: 'urn:adsk.wipprod:fs.folder:co.lw7b0sXUQ-6hWRgf34hBuw' meta: link: href: 'https://developer.api.autodesk.com/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn:adsk.wipprod:fs.folder:co.lw7b0sXUQ-6hWRgf34hBuw' topFolders: links: related: href: 'https://developer.api.autodesk.com/project/v1/hubs/b.622cb5d1-581b-4a46-a6d9-4ebc68ea4051/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/topFolders' issues: data: type: issueContainerId id: 93f8bd6a-2222-415c-8d58-c8fa7c292044 meta: link: href: 'https://developer.api.autodesk.com/issues/v1/containers/93f8bd6a-2222-415c-8d58-c8fa7c292044/issues' submittals: data: type: submittalContainerId id: c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d meta: link: href: 'https://developer.api.autodesk.com/submittals/v1/containers/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items' rfis: data: type: rfisContainerId id: 93f8bd6a-2222-415c-8d58-c8fa7c292044 meta: link: href: 'https://developer.api.autodesk.com/bim360/rfis/v1/containers/93f8bd6a-2222-415c-8d58-c8fa7c292044/rfis' markups: data: type: markupsContainerId id: 93f8bd6a-2222-415c-8d58-c8fa7c292044 meta: link: href: 'https://developer.api.autodesk.com/issues/v1/containers/93f8bd6a-2222-415c-8d58-c8fa7c292044/markups' checklists: data: type: checklistsContainerId id: 93f8bd6a-2222-415c-8d58-c8fa7c292044 meta: link: href: 'https://developer.api.autodesk.com/bim360/checklists/v1/containers/93f8bd6a-2222-415c-8d58-c8fa7c292044/instances' cost: data: type: costContainerId id: c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d meta: link: href: 'https://developer.api.autodesk.com/cost/v1/containers/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/budgets' locations: data: type: locationsContainerId id: 5010258a-a341-4d95-8046-3905e1a983a6 meta: link: href: 'https://developer.api.autodesk.com/bim360/locations/v2/containers/5010258a-a341-4d95-8046-3905e1a983a6/trees/default/nodes' title: ProjectsResponse properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/PaginationInfo' data: type: array uniqueItems: true minItems: 1 description: An array of objects where each object represents a project. items: $ref: '#/components/schemas/ProjectData' Project: description: An object that represents a project. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: 'https://developer.api.autodesk.com/project/v1/hubs/b.622cb5d1-581b-4a46-a6d9-4ebc68ea4051/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d' data: type: projects id: b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d attributes: name: my project scopes: - global extension: type: 'projects:autodesk.bim360:Project' version: '1.0' schema: href: 'https://developer.api.autodesk.com/schema/v1/versions/projects:autodesk.bim360:Project-1.0' data: projectType: BIM360 links: self: href: 'https://developer.api.autodesk.com/project/v1/hubs/b.622cb5d1-581b-4a46-a6d9-4ebc68ea4051/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d' webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d' relationships: hub: data: type: hubs id: b.622cb5d1-581b-4a46-a6d9-4ebc68ea4051 links: related: href: 'https://developer.api.autodesk.com/project/v1/hubs/b.622cb5d1-581b-4a46-a6d9-4ebc68ea4051' rootFolder: data: type: folders id: 'urn:adsk.wipprod:fs.folder:co.lw7b0sXUQ-6hWRgf34hBuw' meta: link: href: 'https://developer.api.autodesk.com/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn:adsk.wipprod:fs.folder:co.lw7b0sXUQ-6hWRgf34hBuw' topFolders: links: related: href: 'https://developer.api.autodesk.com/project/v1/hubs/b.622cb5d1-581b-4a46-a6d9-4ebc68ea4051/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/topFolders' issues: data: type: issueContainerId id: 93f8bd6a-2222-415c-8d58-c8fa7c292044 meta: link: href: 'https://developer.api.autodesk.com/issues/v1/containers/93f8bd6a-2222-415c-8d58-c8fa7c292044/issues' submittals: data: type: submittalContainerId id: c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d meta: link: href: 'https://developer.api.autodesk.com/submittals/v1/containers/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items' rfis: data: type: rfisContainerId id: 93f8bd6a-2222-415c-8d58-c8fa7c292044 meta: link: href: 'https://developer.api.autodesk.com/bim360/rfis/v1/containers/93f8bd6a-2222-415c-8d58-c8fa7c292044/rfis' markups: data: type: markupsContainerId id: 93f8bd6a-2222-415c-8d58-c8fa7c292044 meta: link: href: 'https://developer.api.autodesk.com/issues/v1/containers/93f8bd6a-2222-415c-8d58-c8fa7c292044/markups' checklists: data: type: checklistsContainerId id: 93f8bd6a-2222-415c-8d58-c8fa7c292044 meta: link: href: 'https://developer.api.autodesk.com/bim360/checklists/v1/containers/93f8bd6a-2222-415c-8d58-c8fa7c292044/instances' cost: data: type: costContainerId id: c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d meta: link: href: 'https://developer.api.autodesk.com/cost/v1/containers/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/budgets' locations: data: type: locationsContainerId id: 5010258a-a341-4d95-8046-3905e1a983a6 meta: link: href: 'https://developer.api.autodesk.com/bim360/locations/v2/containers/5010258a-a341-4d95-8046-3905e1a983a6/trees/default/nodes' title: Project properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: $ref: '#/components/schemas/ProjectData' ProjectData: description: A container of data describing a project. x-stoplight: id: 451b000a5238b type: object properties: type: $ref: '#/components/schemas/type_project' x-stoplight: id: 4dv3p70oti08b id: type: string x-stoplight: id: dzcl5hfgt4r93 description: The ID that uniquely identifies the project. attributes: type: object x-stoplight: id: 6zye74w1eaxej description: The properties of the project. properties: name: type: string x-stoplight: id: jbrc4a2pdiax2 description: A human friendly name to identify the project. scopes: type: array x-stoplight: id: tw6kt8la7j04w description: The array of scopes that apply to this project. items: x-stoplight: id: ucml78phoszx6 type: string extension: $ref: '#/components/schemas/project_extension_with_schema_link' x-stoplight: id: c52py6l7draj4 relationships: type: object x-stoplight: id: cjtadsco0iygc description: Contains links to resources related to this project. properties: hub: $ref: '#/components/schemas/json_api_relationships_links_internal_resource' rootFolder: $ref: '#/components/schemas/json_api_relationships_links_root_folder' topFolders: type: object x-stoplight: id: 8cmoc0n8togwm description: Information about the highest level folders you have access to. properties: links: $ref: '#/components/schemas/json_api_links_related' x-stoplight: id: id8zr6r4w6ttj issues: $ref: '#/components/schemas/json_api_relationships_links_only_bim' submittals: $ref: '#/components/schemas/json_api_relationships_links_only_bim' rfis: $ref: '#/components/schemas/json_api_relationships_links_only_bim' markups: $ref: '#/components/schemas/json_api_relationships_links_only_bim' checklists: $ref: '#/components/schemas/json_api_relationships_links_only_bim' cost: $ref: '#/components/schemas/json_api_relationships_links_only_bim' locations: $ref: '#/components/schemas/json_api_relationships_links_only_bim' links: $ref: '#/components/schemas/json_api_links_self_and_web_view' x-stoplight: id: w2gakle3ilykr required: - type - id - attributes TopFolders: description: An object that reporesents a top-level folder. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: /project/v1/hubs/b.622cb5d1-581b-4a46-a6d9-4ebc68ea4051/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/topFolders data: - type: folders id: 'urn:adsk.wipprod:dm.folder:hC6k4hndRWaeIVhIjvHu8w' attributes: name: Plans displayName: Plans createTime: '2015-11-27T11:11:23.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2015-11-27T11:11:27.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe lastModifiedTimeRollup: '2015-11-27T11:11:27.000Z' objectCount: 4 hidden: false extension: type: 'folders:autodesk.bim360:Folder' version: '1.0' schema: href: 'https://developer.api.autodesk.com/schema/v1/versions/folders%3Aautodesk.bim360%3AFolder-1.0' data: allowedTypes: - folders - 'items:autodesk.bim360:File' - 'items:autodesk.bim360:Document' - 'items:autodesk.bim360:TitleBlock' visibleTypes: - folders - 'items:autodesk.bim360:Document' isRoot: false folderType: normal folderParents: - urn: 'urn:adsk.wipprod:fs.folder:co.R3JhbmRwYXJlbnQK' isRoot: true title: Project Files parentUrn: 'urn:adsk.wipprod:fs.folder:co.R3JlYXQgR3JhbmRwYXJlbnQK' - urn: 'urn:adsk.wipprod:fs.folder:co.5-pCTuRbQI2fosqUJoNJ9w' isRoot: false title: ViewOnlySupportTest parentUrn: 'urn:adsk.wipprod:fs.folder:co.UGFyZW50Cg' namingStandardIds: [] links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w' relationships: parent: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/parent data: type: folders id: 'urn:adsk.wipprod:dm.folder:sdfedf8wefl' refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/refs links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/relationships/links contents: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/contents title: TopFolders properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: type: array uniqueItems: true minItems: 1 description: Array of objects where each object represents a top-level folder. items: $ref: '#/components/schemas/TopFolderData' required: - jsonapi - links Folder: description: An object that represents a folder. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w data: type: folders id: 'urn:adsk.wipprod:dm.folder:hC6k4hndRWaeIVhIjvHu8w' attributes: name: Plans displayName: Plans createTime: '2015-11-27T11:11:23.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2015-11-27T11:11:27.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe lastModifiedTimeRollup: '2015-11-27T11:11:27.000Z' objectCount: 4 hidden: false extension: type: 'folders:autodesk.bim360:Folder' version: '1.0' schema: href: 'https://developer.api.autodesk.com/schema/v1/versions/folders%3Aautodesk.bim360%3AFolder-1.0' data: allowedTypes: - folders - 'items:autodesk.bim360:File' - 'items:autodesk.bim360:Document' - 'items:autodesk.bim360:TitleBlock' visibleTypes: - folders - 'items:autodesk.bim360:Document' namingStandardIds: [] links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w' relationships: parent: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/parent data: type: folders id: 'urn:adsk.wipprod:dm.folder:sdfedf8wefl' refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/refs links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/relationships/links contents: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/contents title: Folder properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: $ref: '#/components/schemas/FolderData' FolderData: title: 'Folder Data:' x-stoplight: id: 0crrh7a4rnsne type: object description: A container of data describing a folder. properties: type: $ref: '#/components/schemas/type_folder' id: type: string minLength: 1 description: The unique identifier of the folder. attributes: $ref: '#/components/schemas/FolderAttributesWithExtensions' links: $ref: '#/components/schemas/json_api_links_self_and_web_view' relationships: type: object description: Contains links to resources that are directly related to this folder. required: - parent - refs - links - contents properties: parent: $ref: '#/components/schemas/json_api_relationships_links_folder_parent' refs: $ref: '#/components/schemas/json_api_relationships_links_refs' links: $ref: '#/components/schemas/json_api_relationships_links_links' contents: $ref: '#/components/schemas/json_api_relationships_links_internal' required: - type - id - attributes - links - relationships TopFolderData: title: 'Top-level Folder Data:' x-stoplight: id: 0crrh7a4rnsne type: object description: An object containing information about a top-level folder. properties: type: $ref: '#/components/schemas/type_folder' id: type: string minLength: 1 description: The unique identifier of the folder. attributes: $ref: '#/components/schemas/TopFolderAttributesWithExtensions' links: $ref: '#/components/schemas/json_api_links_self_and_web_view' relationships: type: object required: - parent - refs - links - contents properties: parent: $ref: '#/components/schemas/json_api_relationships_links_folder_parent' refs: $ref: '#/components/schemas/json_api_relationships_links_refs' links: $ref: '#/components/schemas/json_api_relationships_links_links' contents: $ref: '#/components/schemas/json_api_relationships_links_internal' required: - type - id - attributes - links - relationships FolderAttributesWithExtensions: title: 'Folder Attributes:' type: object description: The properties of a folder. required: - name - displayName - objectCount - createTime - createUserId - createUserName - lastModifiedTime - lastModifiedUserId - lastModifiedUserName - hidden properties: name: type: string minLength: 1 description: The name of the folder. displayName: type: string minLength: 1 description: Reserved for future Use. Do not use. Use ``attributes.name`` for the folder name. objectCount: type: integer format: int32 description: The number of objects inside the folder. createTime: type: string format: date-time description: 'The time the folder was created, in the following format: ``YYYY-MM-DDThh:mm:ss.sz``.' createUserId: type: string minLength: 1 description: The unique identifier of the user who created the folder. createUserName: type: string minLength: 1 description: The name of the user who created the folder. lastModifiedTime: type: string format: date-time description: 'The last time the folder was modified, in the following format: ``YYYY-MM-DDThh:mm:ss.sz``.' lastModifiedUserId: type: string minLength: 1 description: 'The last time the folder was modified, in the following format: ``YYYY-MM-DDThh:mm:ss.sz``.' lastModifiedUserName: type: string minLength: 1 description: The name of the user who last modified the folder. lastModifiedTimeRollup: type: string minLength: 1 description: The date and time the folder or any of its children were last updated. hidden: type: boolean description: The folder’s current visibility state. extension: $ref: '#/components/schemas/folder_extension_with_schema_link' TopFolderAttributesWithExtensions: title: 'Folder Attributes:' type: object description: The properties of a folder. required: - name - displayName - objectCount - createTime - createUserId - createUserName - lastModifiedTime - lastModifiedUserId - lastModifiedUserName - hidden properties: name: type: string minLength: 1 description: The name of the folder. displayName: type: string minLength: 1 description: Reserved for future Use. Do not use. Use ``attributes.name`` for the folder name. objectCount: type: integer format: int32 description: The number of objects inside the folder. createTime: type: string format: date-time description: 'The time the folder was created, in the following format: ``YYYY-MM-DDThh:mm:ss.sz``.' createUserId: type: string minLength: 1 description: The unique identifier of the user who created the folder. createUserName: type: string minLength: 1 description: The name of the user who created the folder. lastModifiedTime: type: string description: 'The last time the folder was modified, in the following format: ``YYYY-MM-DDThh:mm:ss.sz``.' format: date-time lastModifiedUserId: type: string minLength: 1 description: 'The last time the folder was modified, in the following format: ``YYYY-MM-DDThh:mm:ss.sz``.' lastModifiedUserName: type: string minLength: 1 description: The name of the user who last modified the folder. lastModifiedTimeRollup: type: string minLength: 1 description: The date and time the folder or any of its children were last updated. hidden: type: boolean description: The folder’s current visibility state. extension: $ref: '#/components/schemas/top_folder_extension_with_schema_link' folder_extension_with_schema_link: type: object description: A container of additional properties that extends the default properties of this resource. properties: type: type: string minLength: 1 description: The type of folder the resource represents. version: type: string minLength: 1 description: The version of the folder type. schema: $ref: '#/components/schemas/json_api_link' data: type: object additionalProperties: type: object description: | JSON objects that contain additional properties specific to the folder type. description: 'The object that contains the additional properties, which makes this resource extensible.' required: - type - version - schema top_folder_extension_with_schema_link: type: object x-stoplight: id: b34ee9d385f4d description: A container of additional properties that extends the default properties of this resource. properties: type: type: string minLength: 1 description: The type of folder the resource represents. version: type: string minLength: 1 description: The version of the folder type. schema: $ref: '#/components/schemas/json_api_link' data: type: object additionalProperties: type: object description: | JSON objects that contain additional properties specific to the folder type. description: 'The object that contains the additional properties, which makes this resource extensible.' required: - type - version - schema FolderContents: description: Successful retrieval of the folder contents collection associated with a specific folder. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3Asdfedf8wefl/contents?page%5Bnumber%5D=3 first: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3Asdfedf8wefl/contents?page%5Bnumber%5D=0 prev: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3Asdfedf8wefl/contents?page%5Bnumber%5D=2 next: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3Asdfedf8wefl/contents?page%5Bnumber%5D=4 data: - type: folders id: 'urn:adsk.wipprod:dm.folder:hC6k4hndRWaeIVhIjvHu8w' attributes: name: Plans displayName: Plans createTime: '2015-11-27T11:11:23.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2015-11-27T11:11:27.000Z' lastModifiedTimeRollup: '2015-11-27T11:11:27.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe path: /dm-test-root/f0cb4ba0-7722-0133-9814-0eeb7bad1e3b objectCount: 4 hidden: false extension: type: 'folders:autodesk.bim360:Folder' version: '1.0' schema: href: /schema/v1/versions/folders%3Aautodesk.bim360%3AFolder-1.0 data: allowedTypes: - folders - 'items:autodesk.bim360:File' - 'items:autodesk.bim360:Document' - 'items:autodesk.bim360:TitleBlock' visibleTypes: - folders - 'items:autodesk.bim360:Document' namingStandardIds: [] links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w relationships: parent: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3Asdfedf8wefl data: type: folders id: 'urn:adsk.wipprod:dm.folder:sdfedf8wefl' refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/refs links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/relationships/links contents: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/contents - type: items id: 'urn:adsk.wipprod:dm.lineage:hC6k4hndRWaeIVhIjvHu8w' attributes: displayName: my file createTime: '2015-11-27T11:11:23.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2015-11-27T11:11:27.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe lastModifiedTimeRollup: '2015-11-27T11:11:27.000Z' hidden: false reserved: true reservedTime: '2015-11-27T11:11:25.000Z' reservedUserId: BW9RM76WZBGL reservedUserName: John Doe extension: type: 'items:autodesk.bim360:File' version: '1.0' schema: href: /schema/v1/versions/items%3Aautodesk.bim360%3AFile-1.0 data: {} links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3AhC6k4hndRWaeIVhIjvHu8w relationships: tip: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3AhC6k4hndRWaeIVhIjvHu8w/tip data: type: versions id: 'urn:adsk.wipprod:fs.file:vf.d34fdsg3g?version=2' versions: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3AhC6k4hndRWaeIVhIjvHu8w/versions refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3AhC6k4hndRWaeIVhIjvHu8w/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3AhC6k4hndRWaeIVhIjvHu8w/refs links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3AhC6k4hndRWaeIVhIjvHu8w/relationships/links parent: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3Asdfedf8wefl data: type: folders id: 'urn:adsk.wipprod:dm.folder:sdfedf8wefl' included: - type: versions id: 'urn:adsk.wipprod:fs.file:vf.d34fdsg3g?version=2' attributes: name: version-test.pdf displayName: version-test.pdf createTime: '2016-04-01T11:09:03.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-04-01T11:11:18.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe versionNumber: 2 mimeType: application/pdf extension: type: 'versions:autodesk.bim360:File' version: '1.0' schema: href: /schema/v1/versions/versions%3Aautodesk.bim360%3AFile-1.0 data: tempUrn: null properties: {} storageUrn: 'urn:adsk.objects:os.object:wip.dm.prod/3c8f6bbc-fe5c-4815-a92e-8b8635e7b1cb.pdf' storageType: OSS conformingStatus: NONE links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1 webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.0J4paz_FQgWPX2QRsaBkiw/detail/viewer/items/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1' relationships: item: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ab909RzMKR4mhc3O7UBY_8g data: type: items id: 'urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1/refs links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1/relationships/links storage: meta: link: href: '/oss/v2/buckets/wipbucket/objects/3c8f6bbc-fe5c-4815-a92e-8b8635e7b1cb.pdf?scopes=b360project.6f8813fe-31a7-4440-bc63-d8ca97c856b4,global,O2tenant.tenantId' data: type: objects id: 'urn:adsk.objects:os.object:wip.dm.prod/3c8f6bbc-fe5c-4815-a92e-8b8635e7b1cb.pdf' title: 'Folder Contents:' properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: type: object description: 'Information on links for this resource. ``first``, ``prev``, and ``next`` are available only when the response is paginated.' required: - self properties: self: $ref: '#/components/schemas/json_api_link' first: $ref: '#/components/schemas/json_api_link' prev: $ref: '#/components/schemas/json_api_link' next: $ref: '#/components/schemas/json_api_link' data: type: array uniqueItems: true minItems: 1 description: 'The properties of an item or folder, as the case may be.' items: oneOf: - $ref: '#/components/schemas/FolderData' - $ref: '#/components/schemas/ItemData' discriminator: propertyName: type mapping: folders: '#/components/schemas/FolderData' items: '#/components/schemas/ItemData' included: description: 'An array of objects, where each element represents a resource included within this resource.' type: array items: $ref: '#/components/schemas/VersionData' required: - jsonapi - links ModifyFolderPayload: description: Modifies folder names x-stoplight: id: 6281aa0793680 type: object x-examples: example-1: jsonapi: version: '1.0' data: type: folders id: 'urn:adsk.wipprod:fs.folder:co.mgS-lb-BThaTdHnhiN_mbA' attributes: name: Drawings title: ModifyFolderPayload properties: jsonapi: $ref: '#/components/schemas/json_api_version' data: type: object description: The data that describes what must be modified. required: - type - id properties: type: $ref: '#/components/schemas/type_folder' id: type: string minLength: 1 description: |- The URN of the folder. For information on how to find the URN, see the initial steps of the [Download a File](/en/docs/data/v2/tutorials/download-file/) tutorial. Note that this should NOT be URL-encoded. attributes: type: object description: The properties of the folder that can be modified. properties: name: type: string minLength: 1 description: |- The new folder name (1-255 characters). Avoid using the following reserved characters in the name: ``<``, ``>``, ``:``, ``"``, ``/``, ``\``, ``|``, ``?``, ``*``, ``'``, ``\n``, ``\r``, ``\t``, ``\0``, ``\f``, ``¢``, ``™``, ``$``, ``®``. When a deleted folder is restored, it keeps its original name. However, if a name conflict occurs, you must provide a new unique name for it. hidden: type: boolean description: |- ``true`` : Delete a BIM 360 Docs folder. ``false`` : Restore a BIM 360 Docs folder. relationships: type: object description: Contains links to resources that are directly related to this folder. properties: parent: type: object description: Information about the parent folder of this folder. properties: data: type: object description: A container for the data that defines the parent of this folder. required: - type - id properties: type: $ref: '#/components/schemas/type_folder' id: type: string description: The URN of the parent folder to which you want to move a folder to. required: - data required: - jsonapi - data Search: description: Successful retrieval of the search results. type: object x-examples: example-1: jsonapi: version: '1.0' data: - type: versions id: 'urn:adsk.wipprod:fs.file:vf.4cW918j8QsynzG0oZ6_Nbg?version=1' attributes: name: sample.txt displayName: sample.txt createTime: '2016-11-09T13:11:27+00:00' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-11-09T13:11:36+00:00' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe versionNumber: 1 fileType: txt extension: type: 'versions:autodesk.bim360:File' version: '1.0' schema: href: /schema/v1/versions/versions%3Aautodesk.bim360%3AFile-1.0 data: processState: PROCESSING_COMPLETE extractionState: UNSUPPORTED splittingState: NOT_SPLIT conformingStatus: NONE links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.4cW918j8QsynzG0oZ6_Nbg%3Fversion%3D1 webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.0J4paz_FQgWPX2QRsaBkiw/detail/viewer/items/urn%3Aadsk.wipprod%3Afs.file%3Avf.4cW918j8QsynzG0oZ6_Nbg%3Fversion%3D1' relationships: item: data: type: items id: 'urn:adsk.wipprod:dm.lineage:4cW918j8QsynzG0oZ6_Nbg' links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.4cW918j8QsynzG0oZ6_Nbg%3Fversion%3D1/item links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.4cW918j8QsynzG0oZ6_Nbg%3Fversion%3D1/relationships/links refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.4cW918j8QsynzG0oZ6_Nbg%3Fversion%3D1/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.4cW918j8QsynzG0oZ6_Nbg%3Fversion%3D1/refs downloadFormats: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.4cW918j8QsynzG0oZ6_Nbg%3Fversion%3D1/downloadFormats derivatives: data: type: derivatives id: dXJuOmFkc2sud2lwc3RnOmZzLmZpbGU6dmYuNGNXOTE4ajhRc3luekcwb1o2X05iZz92ZXJzaW9uPTE meta: link: href: '/modelderivative/v2/designdata/dXJuOmFkc2sud2lwc3RnOmZzLmZpbGU6dmYuNGNXOTE4ajhRc3luekcwb1o2X05iZz92ZXJzaW9uPTE/manifest?scopes=b360project.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d,global,O2tenant.tenantId' thumbnails: data: type: thumbnails id: dXJuOmFkc2sud2lwc3RnOmZzLmZpbGU6dmYuNGNXOTE4ajhRc3luekcwb1o2X05iZz92ZXJzaW9uPTE meta: link: href: '/modelderivative/v2/designdata/dXJuOmFkc2sud2lwc3RnOmZzLmZpbGU6dmYuNGNXOTE4ajhRc3luekcwb1o2X05iZz92ZXJzaW9uPTE/thumbnail?scopes=b360project.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d,global,O2tenant.tenantId' storage: data: type: objects id: 'urn:adsk.objects:os.object:wip.dm.prod/095f7c56-2373-4831-9485-e3546dd501ba.txt' meta: link: href: '/oss/v2/buckets/wip.dm.prod/objects/095f7c56-2373-4831-9485-e3546dd501ba.txt?scopes=b360project.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d,global,O2tenant.tenantId' - type: versions id: 'urn:adsk.wipprod:fs.file:vf.jts1sOfCS6mdwCV38lKpGQ?version=1' attributes: name: sample.pdf displayName: sample.pdf createTime: '2016-11-09T13:13:09+00:00' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-11-09T13:13:42+00:00' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe versionNumber: 1 fileType: pdf extension: type: 'versions:autodesk.bim360:File' version: '1.0' schema: href: /schema/v1/versions/versions%3Aautodesk.bim360%3AFile-1.0 data: processState: PROCESSING_COMPLETE extractionState: SUCCESS splittingState: NOT_SPLIT reviewState: NOT_IN_REVIEW conformingStatus: NONE links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.jts1sOfCS6mdwCV38lKpGQ%3Fversion%3D1 webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.0J4paz_FQgWPX2QRsaBkiw/detail/viewer/items/urn%3Aadsk.wipprod%3Afs.file%3Avf.jts1sOfCS6mdwCV38lKpGQ%3Fversion%3D1' relationships: item: data: type: items id: 'urn:adsk.wipprod:dm.lineage:jts1sOfCS6mdwCV38lKpGQ' links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.jts1sOfCS6mdwCV38lKpGQ%3Fversion%3D1/item links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.jts1sOfCS6mdwCV38lKpGQ%3Fversion%3D1/relationships/links refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.jts1sOfCS6mdwCV38lKpGQ%3Fversion%3D1/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.jts1sOfCS6mdwCV38lKpGQ%3Fversion%3D1/refs downloadFormats: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.jts1sOfCS6mdwCV38lKpGQ%3Fversion%3D1/downloadFormats derivatives: data: type: derivatives id: dXJuOmFkc2sud2lwc3RnOmZzLmZpbGU6dmYuanRzMXNPZkNTNm1kd0NWMzhsS3BHUT92ZXJzaW9uPTE meta: link: href: '/modelderivative/v2/designdata/dXJuOmFkc2sud2lwc3RnOmZzLmZpbGU6dmYuanRzMXNPZkNTNm1kd0NWMzhsS3BHUT92ZXJzaW9uPTE/manifest?scopes=b360project.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d,global,O2tenant.tenantId' thumbnails: data: type: thumbnails id: dXJuOmFkc2sud2lwc3RnOmZzLmZpbGU6dmYuanRzMXNPZkNTNm1kd0NWMzhsS3BHUT92ZXJzaW9uPTE meta: link: href: '/modelderivative/v2/designdata/dXJuOmFkc2sud2lwc3RnOmZzLmZpbGU6dmYuanRzMXNPZkNTNm1kd0NWMzhsS3BHUT92ZXJzaW9uPTE/thumbnail?scopes=b360project.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d,global,O2tenant.tenantId' storage: data: type: objects id: 'urn:adsk.objects:os.object:wip.dm.prod/f5a8a8e8-9bbc-46cf-bce9-9cc34508c2d4.pdf' meta: link: href: '/oss/v2/buckets/wip.dm.prod/objects/f5a8a8e8-9bbc-46cf-bce9-9cc34508c2d4.pdf?scopes=b360project.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d,global,O2tenant.tenantId' included: - type: items id: 'urn:adsk.wipprod:dm.lineage:4cW918j8QsynzG0oZ6_Nbg' attributes: displayName: sample createTime: '2016-11-09T13:11:27+00:00' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-11-09T13:11:36+00:00' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe hidden: false reserved: true reservedTime: '2016-11-09T13:11:30.000Z' reservedUserId: BW9RM76WZBGL reservedUserName: John Doe extension: type: 'items:autodesk.bim360:File' version: '1.0' schema: href: /schema/v1/versions/items%3Aautodesk.bim360%3AFile-1.0 data: {} links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3A4cW918j8QsynzG0oZ6_Nbg webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.0J4paz_FQgWPX2QRsaBkiw/detail/viewer/items/urn%3Aadsk.wipprod%3Adm.lineage%3A4cW918j8QsynzG0oZ6_Nbg' relationships: tip: data: type: versions id: 'urn:adsk.wipprod:fs.file:vf.4cW918j8QsynzG0oZ6_Nbg?version=1' links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3A4cW918j8QsynzG0oZ6_Nbg/tip versions: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3A4cW918j8QsynzG0oZ6_Nbg/versions parent: data: type: folders id: 'urn:adsk.wipprod:fs.folder:co.KJRpLpSXRm66X2HB2Q7AQw' links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3A4cW918j8QsynzG0oZ6_Nbg/parent refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3A4cW918j8QsynzG0oZ6_Nbg/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3A4cW918j8QsynzG0oZ6_Nbg/refs links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3A4cW918j8QsynzG0oZ6_Nbg/relationships/links - type: items id: 'urn:adsk.wipprod:dm.lineage:jts1sOfCS6mdwCV38lKpGQ' attributes: displayName: sample createTime: '2016-11-09T13:13:09+00:00' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-11-09T13:13:41+00:00' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe hidden: false reserved: true reservedTime: '2016-11-09T13:13:24.000Z' reservedUserId: BW9RM76WZBGL reservedUserName: John Doe extension: type: 'items:autodesk.bim360:File' version: '1.0' schema: href: /schema/v1/versions/items%3Aautodesk.bim360%3AFile-1.0 data: {} links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ajts1sOfCS6mdwCV38lKpGQ webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.0J4paz_FQgWPX2QRsaBkiw/detail/viewer/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ajts1sOfCS6mdwCV38lKpGQ' relationships: tip: data: type: versions id: 'urn:adsk.wipprod:fs.file:vf.jts1sOfCS6mdwCV38lKpGQ?version=1' links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ajts1sOfCS6mdwCV38lKpGQ/tip versions: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ajts1sOfCS6mdwCV38lKpGQ/versions parent: data: type: folders id: 'urn:adsk.wipprod:fs.folder:co.KJRpLpSXRm66X2HB2Q7AQw' links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ajts1sOfCS6mdwCV38lKpGQ/parent refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ajts1sOfCS6mdwCV38lKpGQ/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ajts1sOfCS6mdwCV38lKpGQ/refs links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ajts1sOfCS6mdwCV38lKpGQ/relationships/links title: Search properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/PaginationInfo' x-stoplight: id: 0s8wyl26n27l2 data: type: array uniqueItems: true minItems: 1 description: The object containing information on this resource. items: $ref: '#/components/schemas/VersionData' included: type: array uniqueItems: true minItems: 1 description: Information on the latest versions of the items in this resource. items: $ref: '#/components/schemas/ItemData' required: - jsonapi - links - data FolderRefs: x-stoplight: id: t3y8er58rjswv type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: '/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn:adsk.wipprod:dm.folder:hC6k4hndRWaeIVhIjvHu8w/refs' data: - type: folders id: 'urn:adsk.wipprod:dm.folder:hC6k4hndRWaeIVhIjvHu8w' attributes: name: Plans displayName: Plans createTime: '2015-11-27T11:11:23.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2015-11-27T11:11:27.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe objectCount: 4 hidden: false extension: type: 'folders:autodesk.bim360:Folder' version: '1.0' schema: href: 'https://developer.api.autodesk.com/schema/v1/versions/folders%3Aautodesk.bim360%3AFolder-1.0' data: allowedTypes: - folders - 'items:autodesk.bim360:File' - 'items:autodesk.bim360:Document' - 'items:autodesk.bim360:TitleBlock' visibleTypes: - folders - 'items:autodesk.bim360:Document' namingStandardIds: [] links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w' relationships: parent: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/parent data: type: folders id: 'urn:adsk.wipprod:dm.folder:sdfedf8wefl' refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/refs links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/relationships/links contents: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Adm.folder%3AhC6k4hndRWaeIVhIjvHu8w/contents - type: versions id: 'urn:adsk.wipprod:fs.file:vf.b909RzMKR4mhc3O7UBY_8g?version=2' attributes: name: version-test.pdf displayName: version-test.pdf createTime: '2016-04-01T11:12:35.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-04-01T11:15:22.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe versionNumber: 2 mimeType: application/pdf extension: type: 'versions:autodesk.bim360:File' version: '1.0' schema: href: /schema/v1/versions/versions%3Aautodesk.bim360%3AFile-1.0 data: tempUrn: null properties: {} storageUrn: 'urn:adsk.objects:os.object:wip.dm.prod/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf' storageType: OSS conformingStatus: NONE links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2 webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.0J4paz_FQgWPX2QRsaBkiw/detail/viewer/items/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2' relationships: item: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ab909RzMKR4mhc3O7UBY_8g data: type: items id: 'urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/refs links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/relationships/links storage: meta: link: href: '/oss/v2/buckets/wipbucket/objects/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf?scopes=b360project.6f8813fe-31a7-4440-bc63-d8ca97c856b4,global,O2tenant.tenantId' data: type: objects id: 'urn:adsk.objects:os.object:wip.dm.prod/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf' - type: versions id: 'urn:adsk.wipprod:fs.file:vf.b909RzMKR4mhc3O7UBY_8g?version=1' attributes: name: version-test.pdf displayName: version-test.pdf createTime: '2016-04-01T11:09:03.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-04-01T11:11:18.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe versionNumber: 1 mimeType: application/pdf extension: type: 'versions:autodesk.bim360:File' version: '1.0' schema: href: /schema/v1/versions/versions%3Aautodesk.bim360%3AFile-1.0 data: tempUrn: null properties: {} storageUrn: 'urn:adsk.objects:os.object:wip.dm.prod/3c8f6bbc-fe5c-4815-a92e-8b8635e7b1cb.pdf' storageType: OSS conformingStatus: NONE links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1 webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.0J4paz_FQgWPX2QRsaBkiw/detail/viewer/items/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1' relationships: item: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ab909RzMKR4mhc3O7UBY_8g data: type: items id: 'urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1/refs links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1/relationships/links storage: meta: link: href: '/oss/v2/buckets/wipbucket/objects/3c8f6bbc-fe5c-4815-a92e-8b8635e7b1cb.pdf?scopes=b360project.6f8813fe-31a7-4440-bc63-d8ca97c856b4,global,O2tenant.tenantId' data: type: objects id: 'urn:adsk.objects:os.object:wip.dm.prod/3c8f6bbc-fe5c-4815-a92e-8b8635e7b1cb.pdf' - type: items id: 'urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' attributes: displayName: version-test.pdf createTime: '2016-04-01T11:09:03.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-04-01T11:11:18.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe hidden: false reserved: true reservedTime: '2016-04-01T11:10:08.000Z' reservedUserId: BW9RM76WZBGL reservedUserName: John Doe extension: data: {} version: '1.0' type: 'items:autodesk.bim360:File' schema: href: 'https://developer.api.autodesk.com/schema/v1/versions/items%3Aautodesk.bim360%3AFile-1.0' relationships: tip: data: type: versions id: 'urn:adsk.wipprod:fs.file:vf.b909RzMKR4mhc3O7UBY_8g?version=2' links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3AhC6k4hndRWaeIVhIjvHu8w/tip parent: data: type: folders id: 'urn:adsk.wipprod:dm.folder:sdfedf8wefl' links: related: href: '/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/parent' versions: links: related: href: '/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/versions' refs: links: self: href: '/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/relationships/refs' related: href: '/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/refs' links: links: self: href: '/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/relationships/links' links: self: href: '/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.0J4paz_FQgWPX2QRsaBkiw/detail/viewer/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' title: FolderRefs properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: type: array x-stoplight: id: hmbdvuvi4355j description: 'An array of objects, where each object represents a folder, item, or version.' items: x-stoplight: id: 78qlz07jj469e oneOf: - $ref: '#/components/schemas/FolderData' x-stoplight: id: 23uxjwhw6peog - $ref: '#/components/schemas/ItemData' x-stoplight: id: 6bxzhieo6paec - $ref: '#/components/schemas/VersionData' x-stoplight: id: porh9vpw16r4y discriminator: propertyName: type mapping: folders: '#/components/schemas/FolderData' items: '#/components/schemas/ItemData' versions: '#/components/schemas/VersionData' MetaRefs: description: Metadata on the resources referenced by this resource. type: object title: MetaRefs properties: refType: $ref: '#/components/schemas/type_ref' direction: $ref: '#/components/schemas/metarefs_direction' fromId: type: string x-stoplight: id: u4hxp7i1mdfuh description: The ID of the resource from where data flows. fromType: $ref: '#/components/schemas/type_entity' x-stoplight: id: e061oc1d2clmi toId: type: string x-stoplight: id: 4hwdw63giy88s description: The ID of the resource to where the data flows. toType: $ref: '#/components/schemas/type_entity' x-stoplight: id: xnhp75ludslo9 extension: $ref: '#/components/schemas/base_attributes_extension_object_with_schema_link' x-stoplight: id: wnoe4cjsepp56 RelationshipRefsPayload: description: An object that describes the custom relationship to be created. type: object x-examples: example-1: jsonapi: version: '1.0' data: type: versions id: 'urn:adsk.wipprod:fs.file:vf.ooWjwAQJR0uEoPRyfEnvew?version=1' meta: extension: type: 'auxiliary:autodesk.core:Attachment' version: '1.0' title: RelationshipRefsPayload properties: jsonapi: $ref: '#/components/schemas/json_api_version' data: type: object description: A container for the data that describes the custom relationship. required: - type - id - meta properties: type: $ref: '#/components/schemas/type_entity' id: type: string minLength: 1 description: The ID that uniquely identifies the resource. meta: type: object description: The meta-information about this resource. required: - extension properties: extension: $ref: '#/components/schemas/base_attributes_extension_object_without_schema_link' required: - jsonapi - data RelationshipLinks: description: An object containing relationship links of a resource. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: '/data/v1/projects/{some_project_id}/folders/{some_folder_id}/relationships/links' data: - type: links id: 96af4f60-53b8-4efe-b890-1eaa9ea5cb08 meta: link: href: /oss/v2/buckets/wipbucket/objects/myfolder.zip data: type: objects id: 'urn:adsk.objects:os.object:wipbucket/myfolder.zip' mimeType: application/x-zip-compressed extension: type: 'links:A360:DownloadArchiveFolder' version: '1.0' schema: href: /schema/v1/versions/links%3AA360%3ADownloadArchiveFolder-1.0 data: createdTime: '2015-05-22T14:56:28.000Z' - type: links id: cf755d5e-7876-41c2-a58e-2175f9b0cd4b meta: link: href: '/a360/v2/items/{a360folder_id}/create_archive' extension: type: 'links:A360:CreateFolderArchive' version: '1.0' schema: href: /schema/v1/versions/links%3AA360%3ACreateFolderArchive-1.0 title: RelationshipLinks properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: type: array uniqueItems: true minItems: 1 description: An array of objects where each object represents link. items: type: object properties: type: $ref: '#/components/schemas/type_link' id: type: string minLength: 1 description: The ID of the resource. meta: type: object description: The meta-information of the links of this resource. properties: link: $ref: '#/components/schemas/json_api_link' data: type: object description: The object containing meta-information on the data of the links of this resource. properties: type: type: string minLength: 1 description: The type of the resource data. id: type: string minLength: 1 description: The ID or URN of the resource. mimeType: type: string minLength: 1 description: The MIME type of the content of the resource. extension: $ref: '#/components/schemas/base_attributes_extension_object_with_schema_link' Item: description: An object that represents an item. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: 'https://developer.api.autodesk.com/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:hC6k4hndRWaeIVhIjvHu8w' data: type: items id: 'urn:adsk.wipprod:dm.lineage:hC6k4hndRWaeIVhIjvHu8w' attributes: displayName: my_model.rvt createTime: '2018-01-17T11:52:11.0000000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2018-01-17T11:53:19.0000000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe hidden: false reserved: false extension: type: 'items:autodesk.bim360:C4RModel' version: 1.0.0 schema: href: 'https://developer.api.autodesk.com/schema/v1/versions/items:autodesk.bim360:C4RModel-1.0.0' data: sourceFileName: my_model.rvt links: self: href: 'https://developer.api.autodesk.com/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:hC6k4hndRWaeIVhIjvHu8w' webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.0J4paz_FQgWPX2QRsaBkiw/detail/viewer/items/urn:adsk.wipprod:dm.lineage:hC6k4hndRWaeIVhIjvHu8w' relationships: tip: data: type: versions id: 'urn:adsk.wipprod:fs.file:vf.hC6k4hndRWaeIVhIjvHu8w?version=2' links: related: href: 'https://developer.api.autodesk.com/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:hC6k4hndRWaeIVhIjvHu8w/tip' versions: links: related: href: 'https://developer.api.autodesk.com/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:hC6k4hndRWaeIVhIjvHu8w/versions' parent: data: type: folders id: 'urn:adsk.wipprod:fs.folder:co.sdfedf8wef' links: related: href: 'https://developer.api.autodesk.com/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:hC6k4hndRWaeIVhIjvHu8w/parent' refs: links: self: href: 'https://developer.api.autodesk.com/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:hC6k4hndRWaeIVhIjvHu8w/relationships/refs' related: href: 'https://developer.api.autodesk.com/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:hC6k4hndRWaeIVhIjvHu8w/refs' links: links: self: href: 'https://developer.api.autodesk.com/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:hC6k4hndRWaeIVhIjvHu8w/relationships/links' included: - type: versions id: 'urn:adsk.wipprod:fs.file:vf.hC6k4hndRWaeIVhIjvHu8w?version=2' attributes: name: my_model.rvt displayName: my_model createTime: '2018-01-17T11:52:34.0000000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2018-01-17T11:53:20.0000000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe versionNumber: 2 mimeType: application/vnd.autodesk.r360 fileType: rvt extension: type: 'versions:autodesk.bim360:C4RModel' version: 1.0.0 schema: href: 'https://developer.api.autodesk.com/schema/v1/versions/versions:autodesk.bim360:C4RModel-1.0.0' data: modelVersion: 2 projectGuid: project-guid originalItemUrn: 'urn:adsk.wipprod:dm.lineage:hC6k4hndRWaeIVhIjvHu8w' isCompositeDesign: false modelType: multiuser mimeType: application/vnd.autodesk.r360 modelGuid: model-guid processState: PROCESSING_COMPLETE extractionState: SUCCESS splittingState: NOT_SPLIT reviewState: NOT_IN_REVIEW revisionDisplayLabel: '2' sourceFileName: my_model.rvt conformingStatus: NONE links: self: href: 'https://developer.api.autodesk.com/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn:adsk.wipprod:fs.file:vf.hC6k4hndRWaeIVhIjvHu8w%3Fversion=2' webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.0J4paz_FQgWPX2QRsaBkiw/detail/viewer/items/urn:adsk.wipprod:fs.file:vf.hC6k4hndRWaeIVhIjvHu8w%3Fversion%3D2' relationships: item: data: type: items id: 'urn:adsk.wipprod:dm.lineage:hC6k4hndRWaeIVhIjvHu8w' links: related: href: 'https://developer.api.autodesk.com/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn:adsk.wipprod:fs.file:vf.hC6k4hndRWaeIVhIjvHu8w%3Fversion=2/item' links: links: self: href: 'https://developer.api.autodesk.com/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn:adsk.wipprod:fs.file:vf.hC6k4hndRWaeIVhIjvHu8w%3Fversion=2/relationships/links' refs: links: self: href: 'https://developer.api.autodesk.com/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn:adsk.wipprod:fs.file:vf.hC6k4hndRWaeIVhIjvHu8w%3Fversion=2/relationships/refs' related: href: 'https://developer.api.autodesk.com/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn:adsk.wipprod:fs.file:vf.hC6k4hndRWaeIVhIjvHu8w%3Fversion=2/refs' downloadFormats: links: related: href: 'https://developer.api.autodesk.com/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn:adsk.wipprod:fs.file:vf.hC6k4hndRWaeIVhIjvHu8w%3Fversion=2/downloadFormats' derivatives: data: type: derivatives id: derivative-id meta: link: href: 'https://developer.api.autodesk.com/modelderivative/v2/designdata/derivative-id/manifest?scopes=b360project.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d,O2tenant.tenant-id' thumbnails: data: type: thumbnails id: derivative-id meta: link: href: 'https://developer.api.autodesk.com/modelderivative/v2/designdata/derivative-id/thumbnail?scopes=b360project.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d,O2tenant.tenant-id' storage: data: type: objects id: 'urn:adsk.objects:os.object:wip.dm.prod/3c8f6bbc-fe5c-4815-a92e-8b8635e7b1cb.rvt' meta: link: href: 'https://developer.api.autodesk.com/oss/v2/buckets/wip.dm.prod/objects/3c8f6bbc-fe5c-4815-a92e-8b8635e7b1cb.rvt?scopes=b360project.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d,O2tenant.tenant-id' title: Item properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: $ref: '#/components/schemas/ItemData' included: type: array description: An object containing information about the tip version of this item. items: $ref: '#/components/schemas/VersionData' ItemData: title: 'Item Data:' x-stoplight: id: 9jpoyxqpibzmx type: object description: A container of data describing an item. properties: type: $ref: '#/components/schemas/type_item' id: type: string minLength: 1 description: The unique identifier of the item. attributes: $ref: '#/components/schemas/ItemAttributes' relationships: type: object description: Contains links to resources that are directly related to this item. required: - parent - tip - versions - refs - links properties: parent: $ref: '#/components/schemas/json_api_relationships_links_folder_parent' tip: $ref: '#/components/schemas/json_api_relationships_links_to_tip_version' versions: $ref: '#/components/schemas/json_api_relationships_links_versions' refs: $ref: '#/components/schemas/json_api_relationships_links_refs' links: $ref: '#/components/schemas/json_api_relationships_links_links' links: $ref: '#/components/schemas/json_api_links_self_and_web_view' required: - type - id - attributes - relationships - links ItemAttributes: description: Properties of an item. title: 'Item Attributes:' type: object required: - displayName - createTime - createUserId - createUserName - lastModifiedTime - lastModifiedUserId - lastModifiedUserName - extension properties: displayName: type: string minLength: 1 description: |- A human friendly name to identify the item. Note that for BIM 360 projects, this attribute is reserved for future releases and should not be used. Use a version's ``attributes.name`` for the file name. createTime: type: string format: date-time description: The time that the resource was created at. createUserId: type: string minLength: 1 description: The ID of the user that created the version. createUserName: type: string minLength: 1 description: The user name of the user that created the version. lastModifiedTime: type: string format: date-time description: The time that the version was last modified. lastModifiedUserId: type: string minLength: 1 description: The ID of the user that last modified the version. lastModifiedUserName: type: string minLength: 1 description: The user name of the user that last modified the version. hidden: type: boolean description: | ``true``: The file has been deleted. ``false``: The file has not been deleted. reserved: type: boolean description: | ``true``: The file is locked. ``false`` The file is not locked. **Note:** You can lock BIM 360 Project Files folder files and A360 files, but you cannot lock BIM 360 Plans Folder files. reservedTime: type: string format: date-time description: 'The time the item was reserved in the following format: ``YYYY-MM-DDThh:mm:ss.sz``.' reservedUserId: type: string description: The unique identifier of the user who reserved the item. reservedUserName: type: string description: The name of the user who reserved the item. extension: $ref: '#/components/schemas/item_extension_with_schema_link' pathInProject: type: string x-stoplight: id: weoan682ts8ft description: The relative path of the item starting from project’s root folder. ModifyItemPayload: description: An object that defines the attributes of an item that must be updated. x-stoplight: id: 291d5d43ed407 type: object x-examples: example-1: jsonapi: version: '1.0' data: type: items id: 'urn:adsk.wipprod:dm.lineage:AeYgDtcTSuqYoyMweWFhhQ' attributes: displayName: new name for drawing.dwg title: ModifyItemPayload properties: jsonapi: $ref: '#/components/schemas/json_api_version' data: type: object required: - type - id description: The data that describes what must be modified. properties: type: $ref: '#/components/schemas/type_item' id: type: string minLength: 1 description: The ID of the item to be patched. attributes: type: object description: A container of the attributes to be updated. properties: displayName: type: string minLength: 1 description: | A human friendly name to identify an item. **Note:** For BIM 360 projects this attribute is reserved for future releases and should not be used. For such items use a version's ``attributes.name`` as the item's name. required: - jsonapi - data ItemTip: description: An object that represents the tip version of an item. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2 data: type: versions id: 'urn:adsk.wipprod:fs.file:vf.b909RzMKR4mhc3O7UBY_8g?version=2' attributes: name: version-test.pdf displayName: version-test.pdf createTime: '2016-04-01T11:12:35.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-04-01T11:15:22.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe versionNumber: 2 mimeType: application/pdf extension: type: 'versions:autodesk.bim360:File' version: '1.0' schema: href: 'https://developer.api.autodesk.com/schema/v1/versions/versions%3Aautodesk.bim360%3AFile-1.0' data: tempUrn: null properties: {} storageUrn: 'urn:adsk.objects:os.object:wip.dm.prod/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf' storageType: OSS conformingStatus: NONE links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2 webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.0J4paz_FQgWPX2QRsaBkiw/detail/viewer/items/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2' relationships: item: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ab909RzMKR4mhc3O7UBY_8g data: type: items id: 'urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/refs links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/relationships/links storage: meta: link: href: '/oss/v2/buckets/wipbucket/objects/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf?scopes=b360project.6f8813fe-31a7-4440-bc63-d8ca97c856b4,global,O2tenant.tenantId' data: type: objects id: 'urn:adsk.objects:os.object:wip.dm.prod/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf' derivatives: data: type: derivatives id: dXJuOmFkc2sud2lwcWE6ZnMuZmlsZTp2Zi50X3hodWwwYVFkbWhhN2FBaVBuXzlnP3ZlcnNpb249MQ meta: link: href: '/modelderivative/v2/designdata/dXJuOmFkc2sud2lwcWE6ZnMuZmlsZTp2Zi50X3hodWwwYVFkbWhhN2FBaVBuXzlnP3ZlcnNpb249MQ/manifest?scopes=b360project.6f8813fe-31a7-4440-bc63-d8ca97c856b4,global,O2tenant.tenantId' thumbnails: data: type: thumbnails id: dXJuOmFkc2sud2lwcWE6ZnMuZmlsZTp2Zi50X3hodWwwYVFkbWhhN2FBaVBuXzlnP3ZlcnNpb249MQ meta: link: href: '/modelderivative/v2/designdata/dXJuOmFkc2sud2lwcWE6ZnMuZmlsZTp2Zi50X3hodWwwYVFkbWhhN2FBaVBuXzlnP3ZlcnNpb249MQ/thumbnail?scopes=b360project.295285be-9cac-44d6-b365-625ebd327483,global,O2tenant.tenantId' downloadFormats: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/downloadFormats title: ItemTip properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_link' data: $ref: '#/components/schemas/VersionData' Refs: description: Successful retrieval of a resource collection. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: '/data/v1/projects/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjEjMjAyMzAzMTcwMDAwMDAx/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/refs' data: - type: versions id: 'urn:adsk.wipprod:fs.file:vf.b909RzMKR4mhc3O7UBY_8g?version=2' attributes: name: version-test.pdf displayName: version-test.pdf createTime: '2016-04-01T11:12:35.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-04-01T11:15:22.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe versionNumber: 2 mimeType: application/pdf extension: type: 'versions:autodesk.bim360:File' version: '1.0' schema: href: /schema/v1/versions/versions%3Aautodesk.bim360%3AFile-1.0 data: tempUrn: null properties: {} storageUrn: 'urn:adsk.objects:os.object:wip.dm.prod/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf' storageType: OSS conformingStatus: NONE links: self: href: /data/v1/projects/b.6f8813fe-31a7-4440-bc63-d8ca97c856b4/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2 relationships: item: links: related: href: /data/v1/projects/b.6f8813fe-31a7-4440-bc63-d8ca97c856b4/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ab909RzMKR4mhc3O7UBY_8g data: type: items id: 'urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' refs: links: self: href: /data/v1/projects/b.6f8813fe-31a7-4440-bc63-d8ca97c856b4/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/relationships/refs related: href: /data/v1/projects/b.6f8813fe-31a7-4440-bc63-d8ca97c856b4/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/refs links: links: self: href: /data/v1/projects/b.6f8813fe-31a7-4440-bc63-d8ca97c856b4/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/relationships/links storage: meta: link: href: '/oss/v2/buckets/wipbucket/objects/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf?scopes=b360project.6f8813fe-31a7-4440-bc63-d8ca97c856b4,global,O2tenant.tenantId' data: type: objects id: 'urn:adsk.objects:os.object:wip.dm.prod/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf' - type: versions id: 'urn:adsk.wipprod:fs.file:vf.b909RzMKR4mhc3O7UBY_8g?version=1' attributes: name: version-test.pdf displayName: version-test.pdf createTime: '2016-04-01T11:09:03.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-04-01T11:11:18.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe versionNumber: 1 mimeType: application/pdf extension: type: 'versions:autodesk.bim360:File' version: '1.0' schema: href: /schema/v1/versions/versions%3Aautodesk.bim360%3AFile-1.0 data: tempUrn: null properties: {} storageUrn: 'urn:adsk.objects:os.object:wip.dm.prod/3c8f6bbc-fe5c-4815-a92e-8b8635e7b1cb.pdf' storageType: OSS conformingStatus: NONE links: self: href: /data/v1/projects/b.6f8813fe-31a7-4440-bc63-d8ca97c856b4/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1 relationships: item: links: related: href: /data/v1/projects/b.6f8813fe-31a7-4440-bc63-d8ca97c856b4/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ab909RzMKR4mhc3O7UBY_8g data: type: items id: 'urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' refs: links: self: href: /data/v1/projects/b.6f8813fe-31a7-4440-bc63-d8ca97c856b4/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1/relationships/refs related: href: /data/v1/projects/b.6f8813fe-31a7-4440-bc63-d8ca97c856b4/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1/refs links: links: self: href: /data/v1/projects/b.6f8813fe-31a7-4440-bc63-d8ca97c856b4/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1/relationships/links storage: meta: link: href: '/oss/v2/buckets/wipbucket/objects/3c8f6bbc-fe5c-4815-a92e-8b8635e7b1cb.pdf?scopes=b360project.6f8813fe-31a7-4440-bc63-d8ca97c856b4,global,O2tenant.tenantId' data: type: objects id: 'urn:adsk.objects:os.object:wip.dm.prod/3c8f6bbc-fe5c-4815-a92e-8b8635e7b1cb.pdf' - type: items id: 'urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' attributes: displayName: version-test.pdf createTime: '2016-04-01T11:09:03.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-04-01T11:11:18.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe hidden: false reserved: true reservedTime: '2016-04-01T11:10:20.000Z' reservedUserId: BW9RM76WZBGL reservedUserName: John Doe extension: data: {} version: '1.0' type: 'items:autodesk.bim360:File' schema: href: 'https://developer.api.autodesk.com/schema/v1/versions/items%3Aautodesk.bim360%3AFile-1.0' relationships: tip: data: type: versions id: 'urn:adsk.wipprod:fs.file:vf.b909RzMKR4mhc3O7UBY_8g?version=2' links: related: href: /data/v1/projects/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjEjMjAyMzAzMTcwMDAwMDAx/items/urn%3Aadsk.wipprod%3Adm.lineage%3AhC6k4hndRWaeIVhIjvHu8w/tip parent: data: type: folders id: 'urn:adsk.wipprod:dm.folder:sdfedf8wefl' links: related: href: '/data/v1/projects/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjEjMjAyMzAzMTcwMDAwMDAx/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/parent' versions: links: related: href: '/data/v1/projects/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjEjMjAyMzAzMTcwMDAwMDAx/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/versions' refs: links: self: href: '/data/v1/projects/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjEjMjAyMzAzMTcwMDAwMDAx/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/relationships/refs' related: href: '/data/v1/projects/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjEjMjAyMzAzMTcwMDAwMDAx/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/refs' links: links: self: href: '/data/v1/projects/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjEjMjAyMzAzMTcwMDAwMDAx/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/relationships/links' links: self: href: '/data/v1/projects/a.ZXhhbXBsZTp3aXAxZnFhYXV0b2Rlc2sxNjEjMjAyMzAzMTcwMDAwMDAx/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' title: Refs properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: x-stoplight: id: zlvce0hljvqwg description: 'An array of objects, where each object represents a referenced resource (folder, item, or version).' type: array items: x-stoplight: id: cy4i92ra7cxpr oneOf: - $ref: '#/components/schemas/FolderData' x-stoplight: id: rtffmltt1v80u - $ref: '#/components/schemas/ItemData' x-stoplight: id: kmkkve99132f1 - $ref: '#/components/schemas/VersionData' x-stoplight: id: qqyd7tqmmhicv discriminator: propertyName: type mapping: folders: '#/components/schemas/FolderData' items: '#/components/schemas/ItemData' versions: '#/components/schemas/VersionData' required: - jsonapi - links - data RelationshipRefs: description: '' x-stoplight: id: b8ed6741f539a type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: '/data/v1/projects/b.5ae9543e-abd5-45c5-8718-33d26652267f/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/relationships/refs' related: href: '/data/v1/projects/b.5ae9543e-abd5-45c5-8718-33d26652267f/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/refs' data: - type: items id: 'urn:adsk.wipprod:fs.file:vf.b909RzMKR4mhc3O7UBY_8g?version=2' meta: refType: xrefs fromId: 'urn:adsk.wipprod:fs.file:vf.b909RzMKR4mhc3O7UBY_8g?version=2' fromType: versions toId: 'urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' toType: items direction: from extension: type: 'xrefs:my.custom:Xref' version: '1.0' schema: href: '/schema/v1/versions/xrefs:my.custom:Xref-1.0' data: {} included: - type: versions id: 'urn:adsk.wipprod:fs.file:vf.b909RzMKR4mhc3O7UBY_8g?version=2' attributes: name: version-test.pdf displayName: version-test.pdf createTime: '2016-04-01T11:12:35.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-04-01T11:15:22.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe versionNumber: 2 mimeType: application/pdf extension: type: 'versions:autodesk.bim360:File' version: '1.0' schema: href: /schema/v1/versions/versions%3Aautodesk.bim360%3AFile-1.0 data: tempUrn: null properties: {} storageUrn: 'urn:adsk.objects:os.object:wip.dm.prod/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf' storageType: OSS conformingStatus: NONE links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2 webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.0J4paz_FQgWPX2QRsaBkiw/detail/viewer/items/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2' relationships: item: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ab909RzMKR4mhc3O7UBY_8g data: type: items id: 'urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/refs links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/relationships/links storage: meta: link: href: '/oss/v2/buckets/wipbucket/objects/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf?scopes=b360project.6f8813fe-31a7-4440-bc63-d8ca97c856b4,global,O2tenant.tenantId' data: type: objects id: 'urn:adsk.objects:os.object:wip.dm.prod/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf' - type: versions id: 'urn:adsk.wipprod:fs.file:vf.b909RzMKR4mhc3O7UBY_8g?version=1' attributes: name: version-test.pdf displayName: version-test.pdf createTime: '2016-04-01T11:09:03.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-04-01T11:11:18.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe versionNumber: 1 mimeType: application/pdf extension: type: 'versions:autodesk.bim360:File' version: '1.0' schema: href: /schema/v1/versions/versions%3Aautodesk.bim360%3AFile-1.0 data: tempUrn: null properties: {} storageUrn: 'urn:adsk.objects:os.object:wip.dm.prod/3c8f6bbc-fe5c-4815-a92e-8b8635e7b1cb.pdf' storageType: OSS conformingStatus: NONE links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1 webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.0J4paz_FQgWPX2QRsaBkiw/detail/viewer/items/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1' relationships: item: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ab909RzMKR4mhc3O7UBY_8g data: type: items id: 'urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1/refs links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1/relationships/links storage: meta: link: href: '/oss/v2/buckets/wipbucket/objects/3c8f6bbc-fe5c-4815-a92e-8b8635e7b1cb.pdf?scopes=b360project.6f8813fe-31a7-4440-bc63-d8ca97c856b4,global,O2tenant.tenantId' data: type: objects id: 'urn:adsk.objects:os.object:wip.dm.prod/3c8f6bbc-fe5c-4815-a92e-8b8635e7b1cb.pdf' - type: items id: 'urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' attributes: displayName: version-test.pdf createTime: '2016-04-01T11:09:03.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-04-01T11:11:18.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe hidden: false reserved: true reservedTime: '2016-04-01T11:10:00.000Z' reservedUserId: BW9RM76WZBGL reservedUserName: John Doe extension: data: {} version: '1.0' type: 'items:autodesk.bim360:File' schema: href: 'https://developer.api.autodesk.com/schema/v1/versions/items%3Aautodesk.bim360%3AFile-1.0' relationships: tip: data: type: versions id: 'urn:adsk.wipprod:fs.file:vf.b909RzMKR4mhc3O7UBY_8g?version=2' links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3AhC6k4hndRWaeIVhIjvHu8w/tip parent: data: type: folders id: 'urn:adsk.wipprod:dm.folder:sdfedf8wefl' links: related: href: '/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/parent' versions: links: related: href: '/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/versions' refs: links: self: href: '/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/relationships/refs' related: href: '/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/refs' links: links: self: href: '/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g/relationships/links' links: self: href: '/data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.0J4paz_FQgWPX2QRsaBkiw/detail/viewer/items/urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' title: RelationshipRefs properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: oneOf: - $ref: '#/components/schemas/json_api_links_self' x-stoplight: id: ncsj1gqlzx0w1 - $ref: '#/components/schemas/json_api_links_related' x-stoplight: id: 6typpmchmdrk0 description: Information on links to this resource. data: type: array uniqueItems: true minItems: 1 description: 'An array of objects where each object represents the data of a folder, item, or resource.' items: type: object properties: type: $ref: '#/components/schemas/type_entity' x-stoplight: id: h9tic0vwmri2v id: type: string x-stoplight: id: x2owtaamfdr3z description: The ID that uniquely identifies the resource. meta: $ref: '#/components/schemas/MetaRefs' x-stoplight: id: rp3g1jl3ze12n included: type: array x-stoplight: id: 5qk2m98clernk description: 'An array of objects, where each object represents a folder, item, or version included within this resource.' items: x-stoplight: id: i9y1frfztzdsr oneOf: - $ref: '#/components/schemas/FolderData' x-stoplight: id: xmpzaxcb1y34e - $ref: '#/components/schemas/ItemData' x-stoplight: id: hd6qe25i2uegf - $ref: '#/components/schemas/VersionData' x-stoplight: id: byujkhsqw5k90 discriminator: propertyName: type mapping: folders: '#/components/schemas/FolderData' items: '#/components/schemas/ItemData' versions: '#/components/schemas/VersionData' Versions: description: Successful retrieval of the versions collection associated with a specific item. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g/versions?page%5Bnumber%5D=3 first: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g/versions?page%5Bnumber%5D=0 prev: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g/versions?page%5Bnumber%5D=2 next: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g/versions?page%5Bnumber%5D=4 data: - type: versions id: 'urn:adsk.wipprod:fs.file:vf.b909RzMKR4mhc3O7UBY_8g?version=2' attributes: name: version-test.pdf displayName: version-test.pdf createTime: '2016-04-01T11:12:35.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-04-01T11:15:22.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe versionNumber: 2 mimeType: application/pdf extension: type: 'versions:autodesk.bim360:File' version: '1.0' schema: href: /schema/v1/versions/versions%3Aautodesk.bim360%3AFile-1.0 data: tempUrn: null properties: {} storageUrn: 'urn:adsk.objects:os.object:wip.dm.prod/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf' storageType: OSS conformingStatus: NONE links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2 webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.0J4paz_FQgWPX2QRsaBkiw/detail/viewer/items/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2' relationships: item: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ab909RzMKR4mhc3O7UBY_8g data: type: items id: 'urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/refs links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/relationships/links storage: meta: link: href: '/oss/v2/buckets/wipbucket/objects/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf?scopes=b360project.6f8813fe-31a7-4440-bc63-d8ca97c856b4,global,O2tenant.tenantId' data: type: objects id: 'urn:adsk.objects:os.object:wip.dm.prod/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf' - type: versions id: 'urn:adsk.wipprod:fs.file:vf.b909RzMKR4mhc3O7UBY_8g?version=1' attributes: name: version-test.pdf displayName: version-test.pdf createTime: '2016-04-01T11:09:03.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-04-01T11:11:18.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe versionNumber: 1 mimeType: application/pdf extension: type: 'versions:autodesk.bim360:File' version: '1.0' schema: href: /schema/v1/versions/versions%3Aautodesk.bim360%3AFile-1.0 data: tempUrn: null properties: {} storageUrn: 'urn:adsk.objects:os.object:wip.dm.prod/3c8f6bbc-fe5c-4815-a92e-8b8635e7b1cb.pdf' storageType: OSS conformingStatus: NONE links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1 webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.0J4paz_FQgWPX2QRsaBkiw/detail/viewer/items/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1' relationships: item: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ab909RzMKR4mhc3O7UBY_8g data: type: items id: 'urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1/refs links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D1/relationships/links storage: meta: link: href: '/oss/v2/buckets/wipbucket/objects/3c8f6bbc-fe5c-4815-a92e-8b8635e7b1cb.pdf?scopes=b360project.6f8813fe-31a7-4440-bc63-d8ca97c856b4,global,O2tenant.tenantId' data: type: objects id: 'urn:adsk.objects:os.object:wip.dm.prod/3c8f6bbc-fe5c-4815-a92e-8b8635e7b1cb.pdf' title: Versions properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/PaginationInfo' data: type: array uniqueItems: true minItems: 1 description: 'An array of objects, where each object represents a version.' items: $ref: '#/components/schemas/VersionData' Version: description: An object that represdents a version. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2 data: type: versions id: 'urn:adsk.wipprod:fs.file:vf.b909RzMKR4mhc3O7UBY_8g?version=2' attributes: name: version-test.pdf displayName: version-test.pdf createTime: '2016-04-01T11:12:35.000Z' createUserId: BW9RM76WZBGL createUserName: John Doe lastModifiedTime: '2016-04-01T11:15:22.000Z' lastModifiedUserId: BW9RM76WZBGL lastModifiedUserName: John Doe versionNumber: 2 mimeType: application/pdf extension: type: 'versions:autodesk.bim360:File' version: '1.0' schema: href: 'https://developer.api.autodesk.com/schema/v1/versions/versions%3Aautodesk.bim360%3AFile-1.0' data: tempUrn: null properties: {} storageUrn: 'urn:adsk.objects:os.object:wip.dm.prod/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf' storageType: OSS conformingStatus: NONE links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2 webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.0J4paz_FQgWPX2QRsaBkiw/detail/viewer/items/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2' relationships: item: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/items/urn%3Aadsk.wipprod%3Adm.lineage%3Ab909RzMKR4mhc3O7UBY_8g data: type: items id: 'urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' refs: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/relationships/refs related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/refs links: links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/relationships/links storage: meta: link: href: '/oss/v2/buckets/wipbucket/objects/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf?scopes=b360project.6f8813fe-31a7-4440-bc63-d8ca97c856b4,global,O2tenant.tenantId' data: type: objects id: 'urn:adsk.objects:os.object:wip.dm.prod/9f8bdc3f-e29c-4ada-ab7b-bb8dfa821163.pdf' derivatives: data: type: derivatives id: dXJuOmFkc2sud2lwcWE6ZnMuZmlsZTp2Zi50X3hodWwwYVFkbWhhN2FBaVBuXzlnP3ZlcnNpb249MQ meta: link: href: '/modelderivative/v2/designdata/dXJuOmFkc2sud2lwcWE6ZnMuZmlsZTp2Zi50X3hodWwwYVFkbWhhN2FBaVBuXzlnP3ZlcnNpb249MQ/manifest?scopes=b360project.6f8813fe-31a7-4440-bc63-d8ca97c856b4,global,O2tenant.tenantId' thumbnails: data: type: thumbnails id: dXJuOmFkc2sud2lwcWE6ZnMuZmlsZTp2Zi50X3hodWwwYVFkbWhhN2FBaVBuXzlnP3ZlcnNpb249MQ meta: link: href: '/modelderivative/v2/designdata/dXJuOmFkc2sud2lwcWE6ZnMuZmlsZTp2Zi50X3hodWwwYVFkbWhhN2FBaVBuXzlnP3ZlcnNpb249MQ/thumbnail?scopes=b360project.295285be-9cac-44d6-b365-625ebd327483,global,O2tenant.tenantId' downloadFormats: links: related: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.b909RzMKR4mhc3O7UBY_8g%3Fversion%3D2/downloadFormats title: Version properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: $ref: '#/components/schemas/VersionData' VersionData: title: 'Version Data:' description: A container of data describing a version. x-stoplight: id: eb2zg50zz7eul type: object properties: type: $ref: '#/components/schemas/type_version' id: type: string minLength: 1 description: URN of the version object. attributes: $ref: '#/components/schemas/VersionAttributes' relationships: type: object description: Contains information on other resources related to this resource. required: - item - refs - links properties: item: type: object description: Contains information about the item this is a version of. properties: links: $ref: '#/components/schemas/json_api_links_related' x-stoplight: id: fklud6hg20fwz data: $ref: '#/components/schemas/json_api_type_id' x-stoplight: id: g661wq5zxnxxz refs: $ref: '#/components/schemas/json_api_relationships_links_refs' links: $ref: '#/components/schemas/json_api_relationships_links_links' storage: type: object x-stoplight: id: p77erscy2c106 description: Contains information about the storage location that contains the binary data of this version. properties: data: $ref: '#/components/schemas/json_api_type_id' meta: $ref: '#/components/schemas/json_api_meta_link' derivatives: type: object x-stoplight: id: 1by3hohlaohio description: Contains information you can use to retrieve the derivatives of this version. properties: data: $ref: '#/components/schemas/json_api_type_id' meta: $ref: '#/components/schemas/json_api_meta_link' thumbnails: type: object x-stoplight: id: hrzlgcn3r896v description: 'Contains the information required to retrieve thumbnails of this version from the Model Derivative service. ' properties: data: $ref: '#/components/schemas/json_api_type_id' meta: $ref: '#/components/schemas/json_api_meta_link' downloadFormats: type: object x-stoplight: id: r875g22qvyi3v description: Contains the endpoint you can use to find out what formats the version can be downloaded as. properties: links: $ref: '#/components/schemas/json_api_links_related' x-stoplight: id: 41n0be6z8nbng links: $ref: '#/components/schemas/json_api_links_self_and_web_view' required: - type - id - attributes - relationships VersionAttributes: description: The properties of a version. type: object title: 'Version Attributes:' required: - name - displayName - versionNumber - createTime - createUserId - createUserName - lastModifiedTime - lastModifiedUserId - lastModifiedUserName - extension properties: name: type: string minLength: 1 description: The file name to be used when synced to local disk. displayName: type: string minLength: 1 description: 'A human friendly name to identify the version. Note that for BIM 360 projects, this field is reserved for future releases and should not be used. Use a version''s ``attributes.name`` for the file name.' mimeType: type: string minLength: 1 description: The MIME type of the content of the version. versionNumber: type: integer format: int32 description: Version number of this versioned file. fileType: type: string x-stoplight: id: yq6z1hqtgy95z description: 'File type, only present if this version represents a file.' storageSize: type: integer x-stoplight: id: ggffb602xjxgs explicitProperties: - type - format - description format: int64 description: 'File size in bytes, only present if this version represents a file.' createTime: type: string format: date-time description: The time that the resource was created at. createUserId: type: string minLength: 1 description: The ID of the user that created the version. createUserName: type: string minLength: 1 description: The user name of the user that created the version. lastModifiedTime: type: string format: date-time description: The time that the version was last modified. lastModifiedUserId: type: string minLength: 1 description: The ID of the user that last modified the version. lastModifiedUserName: type: string minLength: 1 description: The user name of the user that last modified the version. extension: $ref: '#/components/schemas/version_extension_with_schema_link' ModifyVersionPayload: description: An object that contains the information on the version to be patched. x-stoplight: id: 889ddf68f73b5 type: object x-examples: example-1: jsonapi: version: '1.0' data: type: versions id: 'urn:adsk.wipprod:fs.file:vf.ooWjwAQJR0uEoPRyfEnvew?version=1' attributes: name: new name for drawing.dwg title: ModifyVersionPayload properties: jsonapi: $ref: '#/components/schemas/json_api_version' data: type: object description: Contains the information to update required: - type - id properties: type: $ref: '#/components/schemas/type_version' id: type: string minLength: 1 description: 'The URN of the version. Must be the raw URN, and not the URL enocoded URN.' attributes: type: object description: Contains the properties to update properties: name: type: string minLength: 1 description: |- The file name to be used when synced to local disk (1-255 characters). Avoid using the following reserved characters in the name: ``<``, ``>``, ``:``, ``"``, ``/``, ``\``, ``|``, ``?``, ``*``, ``'``, ``\n``, ``\r``, ``\t``, ``\0``, ``\f``, ``¢``, ``™``, ``$``, ``®``. required: - jsonapi - data StoragePayload: description: An object representing a placeholder (storage location) for data. type: object x-examples: example-1: jsonapi: version: '1.0' data: type: objects attributes: name: drawing.dwg relationships: target: data: type: folders id: 'urn:adsk.wipprod:fs.folder:co.mgS-lb-BThaTdHnhiN_mbA' title: StoragePayload properties: jsonapi: $ref: '#/components/schemas/json_api_version' data: type: object description: A container of data describing a storage location. required: - type - attributes - relationships properties: type: $ref: '#/components/schemas/type_object' attributes: type: object description: Properties of the storage location to be created. required: - name properties: name: type: string minLength: 1 description: A human friendly name to identify the resource. relationships: type: object description: Contains information on other resources related to this resource. required: - target properties: target: type: object description: Information about the target object. required: - data properties: data: type: object description: Contains information about the resources related to the item or version the storage location will contain. required: - type - id properties: type: $ref: '#/components/schemas/type_folder_items_for_storage' id: type: string minLength: 1 description: The ID to uniquely identify the resource. required: - jsonapi - data Storage: description: An object representing a storage location. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: /oss/v2/buckets/wipbucket/objects/830b7ac3-dc75-4e36-aa32-7a1cff7599a1.dwg data: type: objects id: 'urn:adsk.objects:os.object:wip.dm.prod.temp/830b7ac3-dc75-4e36-aa32-7a1cff7599a1.dwg' relationships: target: links: related: href: /data/v1/projects/b.6f8813fe-31a7-4440-bc63-d8ca97c856b4/folders/urn%3Aadsk.wipprod%3Adm.folder%3Asdfedf8wefl data: type: folders id: 'urn:adsk.wipprod:dm.folder:sdfedf8wefl' title: Storage properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: type: object description: An object containing information on the storage location. properties: type: $ref: '#/components/schemas/type_object' id: type: string minLength: 1 description: The ID to uniquely identify the storage location. relationships: type: object description: Contains links to resources that are directly related to the storage location. properties: target: type: object description: Information about the target object. properties: links: $ref: '#/components/schemas/json_api_links_related' data: type: object description: Contains information about the folder containing the item or version the storage location is reserved for. properties: type: $ref: '#/components/schemas/type_folder' id: type: string minLength: 1 description: The ID to uniquely identify the resource. FolderPayload: description: Describe the folder to be created. x-stoplight: id: 4dfe49f8c9ec7 type: object x-examples: example-1: jsonapi: version: '1.0' data: type: folders attributes: name: Plans extension: type: 'folders:autodesk.core:Folder' version: '1.0' relationships: parent: data: type: folders id: 'urn:adsk.wipprod:dm.folder:sdfedf8wefl' title: FolderPayload properties: jsonapi: $ref: '#/components/schemas/json_api_version' data: type: object description: The data that describes the folder to be created. required: - type - attributes - relationships properties: type: $ref: '#/components/schemas/type_folder' attributes: type: object description: The properties of the folder to be created. required: - name - extension properties: name: type: string minLength: 1 description: | The name of the new folder (1-255 characters). Avoid using the following reserved characters in the name: ``<``, ``>``, ``:``, ``"``, ``/``, ``\``, ``|``, ``?``, ``*``, ``'``, ``\n``, ``\r``, ``\t``, ``\0``, ``\f``, ``¢``, ``™``, ``$``, ``®``. If you assign the name of a deleted folder to this folder, and later you decide to restore the deleted folder, you will have to rename the deleted folder. extension: type: object description: A container of additional properties that extends the default properties of this resource. required: - type - version properties: type: type: string minLength: 1 description: |- The type of the extension. For BIM 360 Docs folders, use ``folders:autodesk.bim360:Folder``. For all other services, use ``folders:auto`` version: type: string minLength: 1 description: The version of the type. The current version is ``1.0``. data: type: object description: |- The container of additional properties. The additional properties must follow the schema specified by ``type`` and ``version``. Properties that don't follow the schema will be ignored. relationships: type: object description: A container of links to resources that are related to the folder to be created. required: - parent properties: parent: type: object description: Information about the parent of the new folder in the folder hierarchy. required: - data properties: data: type: object description: The data about the parent of the folder to be created. required: - type - id properties: type: $ref: '#/components/schemas/type_folder' id: type: string minLength: 1 description: | The URN of the parent folder. For information on how to find the URN, see the initial steps of the [Download a File](/en/docs/data/v2/tutorials/download-file/) tutorial. Note that for BIM 360 Docs, new folders must be created within an existing folder (e.g., the Plans or Project Files folders), and not directly within the root folder. Permissions, visibility (e.g., ``items:autodesk.bim360:Document`` or ``items:autodesk.bim360:File``), and actions (e.g., OCR) are inherited from the existing parent folder. New folders also inherit subscriptions such as the notifications sent when files are added to a folder. required: - jsonapi - data ItemPayload: description: Describe the item to be created. x-stoplight: id: 4d7bdcc8c19fb type: object x-examples: example-1: jsonapi: version: '1.0' data: type: items attributes: displayName: drawing.dwg extension: type: 'items:autodesk.core:File' version: '1.0' relationships: tip: data: type: versions id: '1' parent: data: type: folders id: 'urn:adsk.wipprod:fs.folder:co.mgS-lb-BThaTdHnhiN_mbA' included: - type: versions id: '1' attributes: name: drawing.dwg extension: type: 'versions:autodesk.core:File' version: '1.0' relationships: storage: data: type: objects id: 'urn:adsk.objects:os.object:wip.dm.prod/2a6d61f2-49df-4d7b-9aed-439586d61df7.dwg' title: ItemPayload properties: jsonapi: $ref: '#/components/schemas/json_api_version' data: type: object description: The data that describes the item to be created. required: - type - attributes - relationships properties: type: $ref: '#/components/schemas/type_item' attributes: type: object description: The properties of the item to be created. required: - extension properties: displayName: type: string minLength: 1 description: | The name of the new item (1-255 characters). Avoid using the following reserved characters in the name: ``<``, ``>``, ``:``, ``"``, ``/``, ``\``, ``|``, ``?``, ``*``, ``'``, ``\n``, ``\r``, ``\t``, ``\0``, ``\f``, ``¢``, ``™``, ``$``, ``®``. extension: type: object description: The Type ID of the schema that defines the structure of the ``extension.data`` object properties: type: type: string minLength: 1 description: | The type of the extension. For BIM 360 Docs files, use ``items:autodesk.bim360:File``. For all other services, use ``items:autodesk.core:File``. version: type: string minLength: 2 description: The version of the schema that applies to the ``extension.data`` object. data: type: object description: | The container of additional properties. The additional properties must follow the schema specified by ``extensions.type`` and ``extensions.version``. Properties that don't follow the schema will be ignored. additionalProperties: type: object description: | Key-value pairs that contain the name and data of the additional properties. relationships: type: object description: A container of links to resources that are related to the item to be created. required: - tip - parent properties: tip: type: object description: 'Information about the first version of the new item, which will be its tip version.' required: - data properties: data: type: object description: The data about the version to be created. required: - type - id properties: type: $ref: '#/components/schemas/type_version' id: type: string minLength: 1 description: An ID to uniquely identify the version. parent: type: object description: Information about the parent of the new item in the folder hierarchy. required: - data properties: data: type: object description: The data about the parent folder. required: - type - id properties: type: $ref: '#/components/schemas/type_folder' id: type: string minLength: 1 description: | The URN of the parent folder. Note that you cannot copy files between folders in different BIM 360 Docs projects and accounts. For information on how to find the URN, see the initial steps of the [Download a File](/en/docs/data/v2/tutorials/download-file/) tutorial. included: type: array uniqueItems: true minItems: 1 description: 'An array of objects, where each object represents a version of the item to be created. In this case there will only be one element in the array.' items: type: object properties: type: $ref: '#/components/schemas/type_version' id: type: string minLength: 1 description: The version number. Will always be ``1``. attributes: type: object description: The properties of the first version of the item to be created. required: - name - extension properties: name: type: string minLength: 1 description: |- The name of the version (1-255 characters). Avoid using the following reserved characters in the name: ``<``, ``>``, ``:``, ``"``, ``/``, ``\``, ``|``, ``?``, ``*``, ``'``, ``\n``, ``\r``, ``\t``, ``\0``, ``\f``, ``¢``, ``™``, ``$ If you are creating a new item by copying a version of an existing item, the name defaults to the name of the source version. extension: type: object description: A container of additional properties that extends the default properties of this resource. properties: type: type: string minLength: 1 description: | The type of the extension. For BIM 360 Docs files, use ``versions:autodesk.bim360:File``. For A360 composite design files, use ``versions:autodesk.a360:CompositeDesign``. For A360 Personal, Fusion Team, or BIM 360 Team files, use ``versions:autodesk.core:File``. version: type: string minLength: 1 description: 'The version of the extension type (``included[i].attributes.extension.type``). The current version is ``1.0``.' data: type: object description: |- The container of the additional properties. The additional properties must follow the schema specified by ``extensions.type`` and ``extensions.version``. Properties that don't follow the schema will be ignored. additionalProperties: type: object description: | Key-value pairs that contain the name and data of the additional properties. relationships: type: object description: A container of links to resources that are related to the item to be created. properties: storage: type: object x-stoplight: id: m2ysucqzvpnyn description: The object containing information on where the binary data of the item is stored. properties: data: type: object description: The data about the location of binary data. required: - type - id properties: type: $ref: '#/components/schemas/type_object' id: type: string description: 'The URN indicating the location of the binary data. This is represented by the ``objectId`` returned when [uploading the file](/en/docs/data/v2/reference/http/buckets-:bucketKey-objects-:objectKey-PUT/).' required: - data refs: $ref: '#/components/schemas/json_api_relationships_refs' x-stoplight: id: tjbzuouct1am7 required: - type - id - attributes meta: $ref: '#/components/schemas/metaForWebhooks' required: - jsonapi - data - included VersionPayload: description: Describe the version to be created. x-stoplight: id: ae5a85813bc92 type: object x-examples: example-1: jsonapi: version: '1.0' data: type: versions attributes: name: drawing.dwg extension: type: 'versions:autodesk.core:File' version: '1.0' relationships: item: data: type: items id: 'urn:adsk.wipprod:dm.lineage:AeYgDtcTSuqYoyMweWFhhQ' storage: data: type: objects id: 'urn:adsk.objects:os.object:wip.dm.prod/980cff2c-f0f8-43d9-a151-4a2d916b91a2.dwg' title: VersionPayload properties: jsonapi: $ref: '#/components/schemas/json_api_version' data: type: object description: The data that describes the version to be created. required: - type - attributes - relationships properties: type: $ref: '#/components/schemas/type_version' attributes: type: object description: The properties of the version to be created. required: - name - extension properties: name: type: string description: |- The file name to be used when synced to local disk (1-255 characters). Avoid using the following reserved characters in the name: ``<``, ``>``, ``:``, ``"``, ``/``, ``\``, ``|``, ``?``, ``*``, ``'``, ``\n``, ``\r``, ``\t``, ``\0``, ``\f``, ``¢``, ``™``, ``$``, ``®``. If you are creating the new version by copying an existing version of another item, the system uses the name of the source by default. However, if you specify a name, it will override the default name. minLength: 1 extension: type: object description: A container of additional properties that extends the default properties of the version to be created. required: - type - version properties: type: type: string minLength: 1 description: The Type ID of the schema that defines the structure of the ``extension.data`` object. version: type: string minLength: 1 description: The version of the schema that applies to the ``extension.data`` object. data: type: object description: | The container of additional properties. The additional properties must follow the schema specified by ``extensions.type`` and ``extensions.version``. Properties that don't follow the schema will be ignored. displayName: type: string description: Reserved for future use. Use ``data.attributes.name`` for the name. relationships: type: object description: A container of links to resources that are related to the version to be created. required: - item properties: item: type: object description: Contains information about the item this is a version of. required: - data properties: data: type: object description: A container of data on the item. required: - type - id properties: type: $ref: '#/components/schemas/type_item' id: type: string minLength: 1 description: The ID that uniquely identifies the item. storage: type: object description: Contains the information about the storage location that contains the binary data of this version. properties: data: type: object description: A container of data on the storage location. required: - type - id properties: type: $ref: '#/components/schemas/type_object' id: type: string minLength: 1 description: The ID that uniquely identifies the storage location. required: - data refs: type: object description: Information on other resources that will share a custom relationship with the version being created. properties: data: type: array description: 'An array of object, where each object represents a reference.' items: type: object properties: type: $ref: '#/components/schemas/type_version' id: type: string description: The URN (Version ID) of the referenced version. meta: type: object description: Contains meta information about the reference. required: - refType - direction - extension properties: refType: $ref: '#/components/schemas/reftypes_xref' direction: $ref: '#/components/schemas/metarefs_direction' extension: type: object description: Contains additional properties that extend the default properties of the relationship. properties: type: $ref: '#/components/schemas/extension_type_core_xref' version: type: string description: The version of the xref type. Currently must be ``1.1.0``. data: type: object properties: nestedType: $ref: '#/components/schemas/nested_xref' required: - nestedType required: - type - id - meta required: - data meta: $ref: '#/components/schemas/metaForWebhooks' required: - jsonapi - data CreatedVersion: description: The payload returned upon successful creation of a new version. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.AABBCCDD%3Fversion%3D5 data: type: versions id: 'urn:adsk:wipprod:fs.file:vf.AABBCCDD?version=5' attributes: name: newname displayName: drawing createTime: '2018-03-26T09:40:16.0000000Z' createUserId: CGT5PFDIZMAS createUserName: Owen lastModifiedTime: '2018-03-26T09:41:16.0000000Z' lastModifiedUserId: CGT5PFDIZMAS lastModifiedUserName: Owen versionNumber: 1 extension: type: 'versions:autodesk.core:File' version: '1.0' data: processState: NEEDS_PROCESSING links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.AABBCCDD%3Fversion%3D5 webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.akd2j_B3Tsu7v6v7Kxf2oQ/detail/viewer/items/urn%3Aadsk.wipprod%3Afs.file%3Avf.AABBCCDD%3Fversion%3D5' included: - type: items id: 'urn:adsk.wipprod:dm.lineage:2344sdfd' attributes: displayName: drawing createTime: '2018-03-26T09:40:16.0000000Z' createUserId: CGT5PFDIZMAS createUserName: Owen lastModifiedTime: '2018-03-26T09:41:16.0000000Z' lastModifiedUserId: CGT5PFDIZMAS lastModifiedUserName: Owen hidden: false reserved: false extension: type: 'items:autodesk.core:File' version: '1.0' links: self: href: /data/v1/projects/b.c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/versions/urn%3Aadsk.wipprod%3Afs.file%3Avf.AABBCCDD%3Fversion%3D5 webView: href: 'https://docs.b360.autodesk.com/projects/c2960674-2d1e-4cc8-a5f0-4b9026fd3f5d/folders/urn%3Aadsk.wipprod%3Afs.folder%3Aco.akd2j_B3Tsu7v6v7Kxf2oQ/detail/viewer/items/urn%3Aadsk.wipprod%3Afs.file%3Avf.AABBCCDD%3Fversion%3D5' title: CreatedVersion properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: type: object description: A container of data describing the version. properties: type: $ref: '#/components/schemas/type_version' id: type: string minLength: 1 description: The ID that uniquely identifies the version (Version ID). The Version ID is the URN of the version. attributes: $ref: '#/components/schemas/VersionAttributes' links: $ref: '#/components/schemas/json_api_links_self_and_web_view' included: description: 'An array of objects, where each object represents a resource included with the object. For example, the item corresponding to the new version.' type: array items: type: object properties: type: $ref: '#/components/schemas/type_item' id: type: string minLength: 1 description: The ID to uniquely identify the resource. attributes: $ref: '#/components/schemas/ItemAttributes' links: type: object description: Contains the links to use to access references of this resource. properties: self: $ref: '#/components/schemas/json_api_links_self' x-stoplight: id: 7nmmtxmp5jbcd related: $ref: '#/components/schemas/json_api_links_related' x-stoplight: id: lcnhwb1kg48xh relationships: type: object description: Contains links to resources that are directly related to this item. required: - tip - versions - parent - refs - links properties: tip: $ref: '#/components/schemas/json_api_relationships_links_to_tip_version' versions: $ref: '#/components/schemas/json_api_relationships_links_versions' parent: $ref: '#/components/schemas/json_api_relationships_links_folder_parent' refs: $ref: '#/components/schemas/json_api_relationships_links_refs' links: $ref: '#/components/schemas/json_api_relationships_links_links' required: - type - id - attributes - links - relationships DownloadFormats: description: Successful retrieval of the available download formats for a specific version. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: '/data/v1/projects/{some_project_id}/versions/{some_version_id}/downloadFormats' data: type: downloadFormats id: 96af4f60-53b8-4efe-b890-1eaa9ea5cb08 attributes: formats: - fileType: pdf - fileType: dwg title: DownloadFormats properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: type: object description: Contains information about the file formats the version can be downloaded as. properties: type: $ref: '#/components/schemas/type_downloadformats' id: type: string minLength: 1 description: The URN of the version. attributes: type: object description: Contains the list of formats. properties: formats: type: array uniqueItems: true minItems: 1 description: 'An array of objects, where each object corresponds to a file format.' items: type: object properties: fileType: type: string minLength: 1 description: The file name extension of the supported file format. Download: description: An object that represents a download. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: '/data/v1/projects/{project_id}/jobs/{job_id}' data: type: jobs id: '{job_id}' attributes: status: queued links: self: href: '/data/v1/projects/{project_id}/jobs/{job_id}' title: Download properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: $ref: '#/components/schemas/DownloadData' DownloadData: type: object title: DownloadData description: A container of the details of the download object. properties: type: $ref: '#/components/schemas/type_downloads' id: type: string minLength: 1 description: An ID to uniquely identify this download. It is identical to the Job ID that was used to generate this download. attributes: type: object description: The properties of the download. properties: format: type: object description: A container of the file format of the download. properties: fileType: type: string description: The file name extension of the file format of the download. links: $ref: '#/components/schemas/json_api_links_self' relationships: type: object description: Contains links to the resources directly related to the download. properties: storage: type: object x-stoplight: id: cc3e3vp8dczsv description: Contains information about the location of the download. properties: data: type: object x-stoplight: id: igosz8uo35vnf description: Contains information about the storage location of the download. properties: type: $ref: '#/components/schemas/type_object' id: type: string x-stoplight: id: g5hi1dz7htcfv description: The URN of the storage location. meta: type: object description: Meta information about the storage location of the download. properties: link: $ref: '#/components/schemas/json_api_link' Downloads: description: Successful retrieval of the available downloads collection associated with a specific version. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: '/data/v1/projects/{project_id}/downloads' data: - type: downloads id: '{download_id}' attributes: format: fileType: pdf relationships: source: links: related: href: '/data/v1/projects/{project_id}/downloads/{download_id}/source' data: type: versions id: '{version_id}' storage: data: type: objects id: 'urn:adsk.objects:os.object:{wip_bucket}/{guid}.pdf' meta: link: href: '/oss/v2/buckets/{wip_bucket}/objects/{guid}.pdf?scopes={list_of_scopes}' links: self: href: '/data/v1/projects/{project_id}/downloads/{download_id}' title: Downloads properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: type: array uniqueItems: true minItems: 1 items: $ref: '#/components/schemas/DownloadData' DownloadPayload: description: The payload for creating a download of a specified format. type: object x-examples: example-1: jsonapi: version: '1.0' data: type: downloads attributes: format: fileType: dwf relationships: source: data: type: versions id: '{version_id}' title: DownloadPayload properties: jsonapi: $ref: '#/components/schemas/json_api_version' data: type: object description: Contains information about the desired download format and the version of the item to convert to this format. required: - type - attributes - relationships properties: type: $ref: '#/components/schemas/type_downloads' attributes: type: object description: Contains information about the desired download format. required: - format properties: format: type: object description: Specifies the desired download format. required: - fileType properties: fileType: type: string minLength: 1 description: 'The file name extension of the desired download format. Must be one of the supported file name extensions returned by the [List Supported Download Formats](/en/docs/data/v2/reference/http/projects-project_id-versions-version_id-downloadFormats-GET/) operation for the specified version.' relationships: type: object required: - source description: 'Contains information about the version the download format is being created for. ' properties: source: type: object required: - data description: Contains information about the version the download format is being created for. properties: data: type: object required: - type - id description: Contains information about the version the download format is being created for. properties: type: $ref: '#/components/schemas/type_version' id: type: string minLength: 1 description: |- The URN of the version the download is being created for. **Note**: Must be the raw string, not the URL encoded string. required: - jsonapi - data CreatedDownload: description: An object that represents the response to a Create Download request. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: '/data/v1/projects/{project_id}/jobs/{job_id}' data: type: jobs id: '{job_id}' attributes: status: queued links: self: href: '/data/v1/projects/{project_id}/jobs/{job_id}' title: CreatedDownload properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: type: array description: 'An array of objects containing a single object, which represents the job that was kicked off.' items: x-stoplight: id: 1m5aja70wjeef type: object properties: type: $ref: '#/components/schemas/type_job' id: type: string x-stoplight: id: jmx3y9d5ri7xd description: A unique ID assigned to identify the job that creates the download. This ID doubles up as the unique ID to identify the download. attributes: type: object x-stoplight: id: o8v6dagb4p1et description: Contains the properties that indicate the current status of the job. properties: status: $ref: '#/components/schemas/downloads_status' links: $ref: '#/components/schemas/json_api_links_self' x-stoplight: id: nyv6w8lt03j4a Job: description: Details of the specified job was returned successfully. type: object x-examples: example-1: jsonapi: version: '1.0' links: self: href: '/data/v1/projects/{project_id}/jobs/{job_id}' data: type: jobs id: '{job_id}' attributes: status: queued links: self: href: '/data/v1/projects/{project_id}/jobs/{job_id}' title: Job properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: type: object description: Contains information about the download creation job. properties: type: $ref: '#/components/schemas/type_job' id: type: string minLength: 1 description: The Job ID of the job creating the download. attributes: type: object description: Contains the properties that indicate the current status of the job. properties: status: type: string minLength: 1 description: 'Indicates the current status of the job, while the job is ``queued``, ``processing``, or ``failed``. If the job is finished, the server returns a HTTP 303 status with the ``location`` header set to the URI to use to fetch the details of the download.' links: $ref: '#/components/schemas/json_api_links_self' PublishModelJobPayload: type: object x-stoplight: id: lx1hfwyhyg160 x-examples: Example 1: type: commands attributes: extension: type: 'commands:autodesk.core:ListItems' version: 1.1.0 data: includePathInProject: true relationships: resources: data: - type: items id: 'urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' description: |- An object that contains the input data required to execute the GetPublishModelJob command. The ListRefs verifies whether a Collaboration for Revit (C4R) model needs to be published to BIM 360 Docs. For more information, see the [GetPublishModelJob topic in the overview section](/en/docs/data/v2/developers_guide/commands/getpublishmodeljob). title: GetPublishModelJob Command properties: type: $ref: '#/components/schemas/type_commands' id: type: string x-stoplight: id: fgnkyol96qhpv description: A unique ID assigned to the process executing the command. attributes: type: object description: A container of the inputs for the command. properties: extension: type: object description: |- An object that contains properties specific to the GetPublishModelJob command, extending the default properties of a command. properties: type: $ref: '#/components/schemas/type_commandtype_GetPublishModelJob' version: type: string description: |- The version of the schema. Must be ``1.0.0`` for the GetPublishModelJob command. relationships: type: object description: Contains a list of resources required for execution of the command. properties: resources: type: object description: Contains the list of items to check. properties: data: type: array description: |- An array of objects, where each object represents an item to check. items: type: object properties: type: $ref: '#/components/schemas/type_item' id: type: string description: |- The URN of the item to check. Use the [Get an Item](/en/docs/data/v2/reference/http/projects-project_id-items-item_id-GET/) operation to verify the URN. PublishModelJob: type: object x-stoplight: id: zffth6sotwyhw x-examples: Example 1: type: commands id: d3bbe753-ae0a-450d-bbe3-cfd4648f0437 attributes: status: complete extension: type: 'commands:autodesk.bim360:C4RModelGetPublishJob' version: 1.0.0 title: GetPublishModelJob Command description: 'The ``data`` object returned by the GetPublishModelJob command, if the model needs publishing. If the model is already published, the ``data`` object will bed ``null``. ' properties: type: $ref: '#/components/schemas/type_commands' id: type: string description: A unique ID assigned to the process executing the command. attributes: type: object description: |- Contains the properties of the response to the GetPublishModelJob command. properties: status: $ref: '#/components/schemas/command_execution_status' extension: type: object description: |- An object that contains properties specific to the GetPublishModelJob command, extending the default properties of a command. properties: type: $ref: '#/components/schemas/type_commandtype_publishmodel' version: type: string description: |- The version of the schema. Must be ``1.0.0`` for the GetPublishModelJob command. ListItemsPayload: type: object x-stoplight: id: 62f5885084630 x-examples: Example 1: type: commands attributes: extension: type: 'commands:autodesk.core:ListItems' version: 1.1.0 data: includePathInProject: true relationships: resources: data: - type: items id: 'urn:adsk.wipprod:dm.lineage:b909RzMKR4mhc3O7UBY_8g' description: |- An object that contains the input data required to execute the ListItems command. The ListItems command retrieves metadata for up to 50 specified items. For example, an item name, or the date it was created. It also returns the tip (latest) version of the items. title: ListItems Command properties: type: $ref: '#/components/schemas/type_commands' attributes: type: object description: A container of the inputs for the command. properties: extension: type: object description: |- An object that contains properties specific to the ListItems command, extending the default properties of a command. properties: type: $ref: '#/components/schemas/type_commandtype_ListItems' version: type: string description: |- The version of the schema. Must be ``1.0.0`` for the ListItems command. data: type: object description: |- Contains the custom properties specific to the ListItems command. properties: includePathInProject: type: boolean description: |- Specify whether to return the ``pathInProject`` attribute in response for BIM 360 Docs projects. ``pathInProject`` is the path to the item relative to the project’s root folder. - ``true``: Response will contain the ``pathInProject`` attribute for BIM 360 Docs projects. - ``false``: (Default) response will not contain the ``pathInProject`` attribute for BIM 360 Docs projects. Setting this parameter to ``true`` on a non-BIM 360 Docs project results in an error. relationships: type: object description: Contains a list of resources required for execution of the command. properties: resources: type: object description: |- Contains the list of items to check. The list can contain up to 50 versions. properties: data: type: array description: |- An array of objects, where each object represents an item to check. items: type: object properties: type: $ref: '#/components/schemas/type_item' id: type: string description: |- The URN of the item to check. Use the [Get an Item](/en/docs/data/v2/reference/http/projects-project_id-items-item_id-GET/) operation to verify the URN. ListItems: type: object x-stoplight: id: zax9zrof8wpdw description: The ``data`` object returned by the ListItems command. title: ListItems Command properties: type: $ref: '#/components/schemas/type_commands' id: type: string description: A unique ID assigned to the process executing the command. attributes: type: object description: |- Contains the properties of the response to the ListItems command. properties: status: $ref: '#/components/schemas/command_execution_status' x-stoplight: id: vmeuk1k3adj1e extension: type: object description: |- An object that contains properties specific to the ListItems command, extending the default properties of a command. properties: type: $ref: '#/components/schemas/type_commandtype_ListItems' version: type: string description: |- The version of the schema. Must be ``1.0.0`` for the ListItems command. relationships: type: object description: |- Contains the list of items that were checked. properties: resources: type: object description: |- Contains the list of items that were checked. properties: data: type: array description: |- An array of objects, where each object represents a item that was checked. items: type: object properties: type: $ref: '#/components/schemas/type_item' id: type: string description: The URN of the item. meta: $ref: '#/components/schemas/ItemData' x-stoplight: id: pqzkd03jixlq1 included: type: array x-stoplight: id: ec89t5hcbgudc description: |- An array of objects, which contains a single object. The object represents the tip version of the item. items: $ref: '#/components/schemas/VersionData' x-stoplight: id: tyrs780ae46um ListItemsTest: type: object x-stoplight: id: s02ljd6gy4mlc description: The ``data`` object returned by the ListItems command. title: ListItems Command properties: type: $ref: '#/components/schemas/type_commands' id: type: string description: A unique ID assigned to the process executing the command. attributes: type: object description: |- Contains the properties of the response to the ListItems command. properties: status: $ref: '#/components/schemas/command_execution_status' x-stoplight: id: vmeuk1k3adj1e extension: type: object description: |- An object that contains properties specific to the ListItems command, extending the default properties of a command. properties: type: $ref: '#/components/schemas/type_commandtype_ListItems' version: type: string description: |- The version of the schema. Must be ``1.0.0`` for the ListItems command. relationships: type: object x-stoplight: id: 1wh0vew0zdgtn properties: resources: type: object x-stoplight: id: awwdpbzinvzf6 properties: meta: $ref: '#/components/schemas/ItemData' x-stoplight: id: dnoedz1567xyx data: type: array x-stoplight: id: 3wbfpnaoxb2cq items: x-stoplight: id: 4jf9dxqgijvfi type: object properties: type: $ref: '#/components/schemas/type_item' x-stoplight: id: 17l1l6w7ck3fx version: type: string x-stoplight: id: spczcrond1qh9 ListRefsPayload: type: object x-stoplight: id: yldmhka0r8snp title: ListRefs Command description: |- An object that contains the input data required to execute the ListRefs command. The ListRefs command retrieves the custom relationships between specified versions of items and other resources in the data domain service (folders, items, and versions). You can retrieve the relationships of up to 50 versions. properties: type: $ref: '#/components/schemas/type_commands' attributes: type: object description: A container of the inputs for the command. properties: extension: type: object description: |- An object that contains properties specific to the ListRefs command, extending the default properties of a command. properties: type: $ref: '#/components/schemas/type_commandtype_ListRefs' version: type: string description: |- The version of the schema. Must be ``1.0.0`` for the ListRefs command. relationships: type: object description: Contains a list of resources required for execution of the command. properties: resources: type: object description: |- Contains the list of versions to check. The list can contain up to 50 versions. properties: data: type: array description: |- An array of objects, where each object represents a version to check. items: type: object properties: type: $ref: '#/components/schemas/type_version' id: type: string description: |- The URN of the version to check. Use the [List all Versions of an Item](/en/docs/data/v2/reference/http/projects-project_id-items-item_id-versions-GET/) operation to verify the URN. ListRefs: type: object x-stoplight: id: osv16gf5xx585 x-examples: Example 1: type: commands id: d3bbe753-ae0a-450d-bbe3-cfd4648f0437 attributes: extension: data: permissions: - type: folders id: 'urn:adsk.wipprod:dm.folder:hC6k4hndRWaeIVhIjvHu8w' details: create: true download: true view: true permission: true - type: folders id: 'urn:adsk.wipprod:dm.folder:iC6k4hndRW5eIVhIjvHu8n' details: create: false download: true view: true permission: false - type: folders id: 'urn:adsk.wipprod:dm.folder:jC6k4hndRW5eIVhIjvHu9x' details: create: false download: false view: false permission: false requiredActions: - create - download - view version: 1.0.0 type: 'commands:autodesk.core:CheckPermission' schema: href: 'https://developer.api.autodesk.com/schema/v1/versions/commands:autodesk.core:CheckPermission-1.0.0' relationships: resources: data: - type: folders id: 'urn:adsk.wipprod:dm.folder:hC6k4hndRWaeIVhIjvHu8w' - type: folders id: 'urn:adsk.wipprod:dm.folder:iC6k4hndRW5eIVhIjvHu8n' - type: folders id: 'urn:adsk.wipprod:dm.folder:jC6k4hndRW5eIVhIjvHu9x' description: The ``data`` object returned by the ListRefs command. title: ListRefs Command properties: type: $ref: '#/components/schemas/type_commands' id: type: string description: A unique ID assigned to the process executing the command. attributes: type: object description: |- Contains the properties of the response to the ListRefs command. properties: status: $ref: '#/components/schemas/command_execution_status' x-stoplight: id: a81ncl7rmmx75 extension: type: object description: |- An object that contains properties specific to the ListRefs command, extending the default properties of a command. properties: type: $ref: '#/components/schemas/type_commandtype_ListRefs' version: type: string description: |- The version of the schema. Must be ``1.0.0`` for the ListRefs command. relationships: type: object description: |- Contains the list of versions that were checked. properties: resources: type: object description: |- Contains the list of versions that were checked. properties: data: type: array description: |- An array of objects, where each object represents a version that was checked. items: type: object properties: type: $ref: '#/components/schemas/type_version' id: type: string description: The URN of the version. meta: $ref: '#/components/schemas/MetaRefs' x-stoplight: id: pqzkd03jixlq1 included: type: array x-stoplight: id: ec89t5hcbgudc description: |- An array of objects, where each object represents a referenced resource. items: x-stoplight: id: tyrs780ae46um oneOf: - $ref: '#/components/schemas/ItemData' - $ref: '#/components/schemas/VersionData' x-stoplight: id: rvp2eydjhj628 discriminator: propertyName: type mapping: items: '#/components/schemas/ItemData' versions: '#/components/schemas/VersionData' CheckPermissionPayload: type: object x-stoplight: id: 422a773ceddf1 x-examples: Example 1: type: commands attributes: extension: type: 'commands:autodesk.core:CheckPermission' version: 1.0.0 data: requiredActions: - download - view - write relationships: resources: data: - type: folders id: 'urn:adsk.wipprod:dm.folder:hC6k4hndRWaeIVhIjvHu8w' - type: folders id: 'urn:adsk.wipprod:dm.folder:iC6k4hndRW5eIVhIjvHu8n' - type: folders id: 'urn:adsk.wipprod:dm.folder:jC6k4hndRW5eIVhIjvHu9x' title: CheckPermission Command description: | An object that contains the input data required to execute the CheckPermission command. The CheckPermission command checks if a user has permission to perform specified actions on specified resources. The user’s identity is derived from the ``x-user-id`` header (in a 2-Legged call), or from the access token (in a 3-Legged call). See the [Developer's Guide topic on the CheckPermission command](/en/docs/data/v2/developers_guide/commands/checkpermission/) for more information. properties: type: $ref: '#/components/schemas/type_commands' attributes: type: object description: A container of the inputs for the command. properties: extension: type: object description: |- An object that contains properties specific to the CheckPermission command, extending the default properties of a command. properties: type: $ref: '#/components/schemas/type_commandtype_CheckPermission' version: type: string description: |- The version of the schema. Must be ``1.0.0`` for the CheckPermission command. data: type: object description: |- Contains the properties specific to the CheckPermission command. properties: requiredActions: type: array description: |- An array of keywords where each keyword is an action that permission must be checked for. Possible values: - ``read`` - Download and view specified resource. - ``view`` - View specified resource without downloading. - ``download`` - Download and view specified resource. - ``collaborate`` - Add comments for the specified resource. - ``write`` - Write to the specified resource. - ``upload`` - Upload to the specified resource. - ``updateMetaData`` - Update metadata of the specified resource. - ``create`` - Write and upload to the specified resource. - ``delete`` - Delete the specified resource. - ``admin`` - Perform administrative operations on specified resource. - ``share``- Share the specified resource. items: type: string relationships: type: object description: Contains a list of resources required for execution of the command. properties: resources: type: object description: |- Contains the list of resources that permission must be checked for. properties: data: type: array description: |- An array of objects, where each object represents a resource. items: type: object properties: type: $ref: '#/components/schemas/type_entity' id: type: string description: The URN of the resource to check. CheckPermission: type: object x-stoplight: id: 800c4853f77b4 x-examples: Example 1: type: commands id: d3bbe753-ae0a-450d-bbe3-cfd4648f0437 attributes: extension: data: permissions: - type: folders id: 'urn:adsk.wipprod:dm.folder:hC6k4hndRWaeIVhIjvHu8w' details: create: true download: true view: true permission: true - type: folders id: 'urn:adsk.wipprod:dm.folder:iC6k4hndRW5eIVhIjvHu8n' details: create: false download: true view: true permission: false - type: folders id: 'urn:adsk.wipprod:dm.folder:jC6k4hndRW5eIVhIjvHu9x' details: create: false download: false view: false permission: false requiredActions: - create - download - view version: 1.0.0 type: 'commands:autodesk.core:CheckPermission' schema: href: 'https://developer.api.autodesk.com/schema/v1/versions/commands:autodesk.core:CheckPermission-1.0.0' relationships: resources: data: - type: folders id: 'urn:adsk.wipprod:dm.folder:hC6k4hndRWaeIVhIjvHu8w' - type: folders id: 'urn:adsk.wipprod:dm.folder:iC6k4hndRW5eIVhIjvHu8n' - type: folders id: 'urn:adsk.wipprod:dm.folder:jC6k4hndRW5eIVhIjvHu9x' description: The ``data`` object returned by the CheckPermission command. title: CheckPermission Command properties: type: $ref: '#/components/schemas/type_commands' id: type: string description: A unique ID assigned to the process executing the command. attributes: type: object description: |- Contains the properties of the response to the CheckPermission command. properties: extension: type: object description: |- An object that contains properties specific to the CheckPermissions command, extending the default properties of a command. properties: type: $ref: '#/components/schemas/type_commandtype_CheckPermission' version: type: string description: |- The version of the schema. Must be ``1.0.0`` for the CheckPermission command. schema: type: object description: Contains the location of the schema. properties: href: type: string description: The hypertext reference to the location of the schema. data: type: object description: |- A container of the results of the resources that were checked for permission. properties: permissions: type: array description: |- An array of objects, where each object represents a folder, item, or version that permission was checked for. items: type: object properties: type: $ref: '#/components/schemas/type_entity' id: type: string description: The URN of the resource. details: type: object description: |- An object containing key value pairs, where the key represents the type of permission that was checked and the value is ``true`` if the user has permission. properties: create: type: boolean download: type: boolean view: type: boolean permission: type: boolean description: |- ``true`` - The user is permitted to perform all the actions checked for. ``false`` - The user is not permitted to perform at least one of the actions checked for. requiredActions: type: array description: |- An array of keywords where each keyword is an action that permission was checked for. Possible values: - ``read`` - Download and view specified resource. - ``view`` - View specified resource without downloading. - ``download`` - Download and view specified resource. - ``collaborate`` - Add comments for the specified resource. - ``write`` - Write to the specified resource. - ``upload`` - Upload to the specified resource. - ``updateMetaData`` - Update metadata of the specified resource. - ``create`` - Write and upload to the specified resource. - ``delete`` - Delete the specified resource. - ``admin`` - Perform administrative operations on specified resource. - ``share``- Share the specified resource. items: type: string relationships: type: object description: |- Contains the list of resources checked for permission. properties: resources: type: object description: |- Contains the list of resources checked for permission. properties: data: type: array items: type: object properties: type: $ref: '#/components/schemas/type_entity' id: type: string description: The URN of the resource. PublishModelPayload: type: object x-stoplight: id: bef2159153e21 x-examples: Example 1: jsonapi: version: '1.0' data: type: commands attributes: extension: type: 'commands:autodesk.bim360:C4RModelPublish' version: 1.0.0 relationships: resources: data: - type: items id: 'urn:adsk.wip:dm.file:hC6k4hndRWaeIVhIjvHu8w' description: | An object that contains the input required to execute the PublishModel command. The PublishModel Command publishes the latest version of a Collaboration for Revit (C4R) model to BIM 360 Docs. See the [Developer's Guide topic on the PublishModel command](/en/docs/data/v2/developers_guide/commands/publishmodel/) for more information. title: PublishModel Command properties: type: $ref: '#/components/schemas/type_commands' attributes: type: object description: A container of the inputs for the command. properties: extension: type: object description: |- An object that contains properties specific to the PublishModel command, extending the default properties of a command. properties: type: $ref: '#/components/schemas/type_commandtype_publishmodel' version: type: string description: |- The version of the schema. Must be ``1.0.0`` for the PublishModel command. relationships: type: object description: Contains a list of resources required for execution of the command. properties: resources: type: object description: Contains the list of resources to be published. properties: data: type: array description: |- An array of objects where each object represents a resource that must be published. items: type: object properties: type: $ref: '#/components/schemas/type_item' id: type: string description: |- The URN of the resource. For information about finding the URN, see the initial steps of the [Publish a C4R Model to BIM 360 Docs](/en/docs/data/v2/tutorials/publish-model/) tutorial. PublishModel: type: object x-stoplight: id: qpahxdkrbaxti x-examples: Example 1: data: type: commands id: d3bbe753-ae0a-450d-bbe3-cfd4648f0437 attributes: status: committed extension: type: 'commands:autodesk.bim360:C4RModelPublish' version: 1.0.0 jsonapi: version: '1.0' description: The ``data`` object returned by the PublishModel command. title: PublishModel Command properties: type: $ref: '#/components/schemas/type_commands' id: type: string description: A unique ID assigned to the process executing the command. attributes: type: object description: |- Contains the properties of the response to the PublishModel command. properties: extension: type: object description: |- An object that contains properties specific to the PublishModel command, extending the default properties of a command. properties: type: $ref: '#/components/schemas/type_commandtype_publishmodel' version: type: string description: |- The version of the schema. Always ``1.0.0`` for the PublishModel command. status: $ref: '#/components/schemas/command_execution_status' PublishWithoutLinksPayload: type: object x-stoplight: id: 7r6evucirhy56 x-examples: Example 1: jsonapi: version: '1.0' data: type: commands attributes: extension: type: 'commands:autodesk.bim360:C4RModelPublish' version: 1.0.0 relationships: resources: data: - type: items id: 'urn:adsk.wip:dm.file:hC6k4hndRWaeIVhIjvHu8w' description: | An object that contains the input data to execute the PublishWithoutLinks command. The PublishWithoutLinks command publishes the latest version of a Collaboration for Revit (C4R) model without the links it contains to BIM 360 Docs. See the [Developer's Guide topic on the PublishWithoutLinks command](/en/docs/data/v2/developers_guide/commands/publishwithoutlinks/) for more information. title: PublishWithoutLinks Command properties: type: $ref: '#/components/schemas/type_commands' attributes: type: object description: A container of the inputs for the command. properties: extension: type: object description: |- An object that contains properties specific to the PublishWithoutLinks command, extending the default properties of a command. properties: type: $ref: '#/components/schemas/type_commandtype_PublishWithoutLinks' version: type: string description: |- The version of the schema. Must be ``1.0.0`` for the PublishWithoutLinks command. relationships: type: object description: Contains a list of resources required for execution of the command. properties: resources: type: object description: Contains the list of resources to be published. properties: data: type: array description: |- An array of objects where each object represents a resource that must be published. items: type: object properties: type: $ref: '#/components/schemas/type_item' id: type: string description: |- The URN of the resource. For information about finding the URN, see the initial steps of the [Publish a C4R Model to BIM 360 Docs](/en/docs/data/v2/tutorials/publish-model/) tutorial. PublishWithoutLinks: type: object x-stoplight: id: f3e99gnqzuv9s x-examples: Example 1: data: type: commands id: d3bbe753-ae0a-450d-bbe3-cfd4648f0437 attributes: status: committed extension: type: 'commands:autodesk.bim360:C4RModelPublish' version: 1.0.0 jsonapi: version: '1.0' description: The ``data`` object returned by the PublishWithoutLinks command. title: PublishWithoutLinks Command properties: type: $ref: '#/components/schemas/type_commands' id: type: string description: A unique ID assigned to the process executing the command. attributes: type: object description: |- Contains the properties of the response to the PublishWithoutLinks command. properties: extension: type: object description: |- An object that contains properties specific to the PublishWithoutLinks command, extending the default properties of a command. properties: type: $ref: '#/components/schemas/type_commandtype_PublishWithoutLinks' version: type: string description: |- The version of the schema. Always ``1.0.0`` for the PublishModel command. status: $ref: '#/components/schemas/command_execution_status' version_extension_with_schema_link: type: object description: A container of additional properties that extends the default properties of a version. properties: type: type: string description: The Type ID of the schema that defines the structure of the ``extension.data`` object. version: type: string description: The version of the schema that applies to the ``extension.data`` object. schema: $ref: '#/components/schemas/json_api_link' data: type: object description: 'The object that contains the additional properties, which makes this resource extensible.' additionalProperties: type: object description: | Key-value pairs that contain the name and data of additional properties. required: - type - version - schema title: '' item_extension_with_schema_link: type: object x-stoplight: id: 7vkthmto6jc8p description: A container of additional properties that extends the default properties of this resource. properties: type: type: string description: The Type ID of the schema that defines the structure of the ``extension.data`` object. version: type: string description: The version of the schema that applies to the ``extension.data`` object. schema: $ref: '#/components/schemas/json_api_link' data: type: object description: The object that contains the additional properties that extends this resource. additionalProperties: type: object description: | Key-value pairs that contain the name and data of additional properties. required: - type - version - schema base_attributes_extension_object_with_schema_link: title: 'base_attributes_extension_object_with_schema_link:' x-stoplight: id: aj8zaihf7alzp type: object description: A container of additional properties that extends this resource. properties: type: type: string x-stoplight: id: jdli2qhh88jq3 description: The Type ID of the schema that defines the structure of the ``extension.data`` object. version: type: string x-stoplight: id: x1l84lpe0ce01 description: The version of the schema that applies to the ``extension.data`` object. schema: type: object x-stoplight: id: el8fixpzd4k3a description: A container for the hyperlink to the schema of the type. required: - href properties: href: type: string x-stoplight: id: oh11qown58iob description: A hypertext reference to the location of the referenced resource. data: type: object x-stoplight: id: 5h0r1ilaapxra description: The object that contains the additional properties that extends this resource. additionalProperties: type: object description: | Key-value pairs that contain the name and data of additional properties. required: - type - version - schema base_attributes_extension_object_without_schema_link: title: 'base_attributes_extension_object_with_schema_link:' x-stoplight: id: rwbl8xfimitn3 type: object description: A container of additional properties that extends this resource. properties: type: type: string x-stoplight: id: jdli2qhh88jq3 description: The Type ID of the schema that defines the structure of the ``extension.data`` object. version: type: string x-stoplight: id: x1l84lpe0ce01 description: The version of the schema that applies to the ``extension.data`` object. data: type: object x-stoplight: id: 5h0r1ilaapxra description: 'The object that contains the additional properties, which makes this resource extensible.' additionalProperties: type: object description: | Key-value pairs that contain the name and data of additional properties. required: - type - version project_extension_with_schema_link: title: project_extension_with_schema_link x-stoplight: id: ztgeolnkjee8a type: object description: A container of additional properties that extends the default properties of this resource. properties: type: type: string x-stoplight: id: 5shuvhdelpby4 description: The Type ID of the schema that defines the structure of the ``extension.data`` object. version: type: string x-stoplight: id: ikdod0rzbn88x description: The version of the schema that applies to the ``extension.data`` object. schema: $ref: '#/components/schemas/json_api_link' data: type: object x-stoplight: id: 6if5zajaqx5gr additionalProperties: type: object description: | Key-value pairs that contain the name and data of additional properties. description: 'The object that contains the additional properties, which makes this resource extensible.' required: - type - version - schema json_api_version: title: json_api_version x-stoplight: id: wtcnivkdziwr7 type: object description: The JSON API object. properties: version: description: The version of JSON API. Will always be ``1.0``. $ref: '#/components/schemas/json_api_version_value' required: - version json_api_version_value: description: The version of JSON API. Will always be ``1.0``. type: string enum: - '1.0' json_api_links_self: title: json_api_links_self x-stoplight: id: hedbm6v3pcz7k type: object description: An object containing the URI of the endpoint to access this resource. properties: self: type: object x-stoplight: id: xjz8a6shpmaya description: An object containing the URI of the endpoint to access this resource. properties: href: type: string x-stoplight: id: jx2lmnxrl8f10 description: |- The URI of the endpoint to access this resource. json_api_link: title: json_api_link x-stoplight: id: 0eyqmow1ie1is type: object description: An object containing the hyperlink to the referenced resource. properties: href: type: string x-stoplight: id: d9k2el45bomh9 description: A hypertext reference to the location of the referenced resource. required: - href json_api_links_related: title: json_api_links_related x-stoplight: id: fgwxlu5412wa7 type: object description: Contains the endpoint you can use to retrieve the related resources. properties: related: type: object x-stoplight: id: o5ksk96io3pui description: |- An object containing the endpoint to retrieve a list of related resources. properties: href: type: string x-stoplight: id: n8345byjqrj4f description: The URI of the endpoint that returns the related resources. json_api_type_id: title: json_api_type_id x-stoplight: id: vj150c8bxpc9d type: object description: An object containing the ``id`` and ``type`` properties of a resource. properties: id: type: string description: The URN of the resource. type: type: string x-stoplight: id: j3iiuzs5pdley description: The type of the resource. json_api_relationships_links_to_tip_version: title: json_api_relationships_links_to_tip_version x-stoplight: id: qmmyfor4fmle9 type: object description: Information about the latest version of the item. properties: links: $ref: '#/components/schemas/json_api_links_related' x-stoplight: id: e35szkgp1o7b8 data: $ref: '#/components/schemas/json_api_type_id' x-stoplight: id: zdowc6ik9vvcu json_api_relationships_links_internal_resource: title: json_api_relationships_links_internal_resource x-stoplight: id: qmmyfor4fmle9 type: object description: Information on the resources above this resource in the hierarchy. properties: links: $ref: '#/components/schemas/json_api_links_related' x-stoplight: id: e35szkgp1o7b8 data: $ref: '#/components/schemas/json_api_type_id' x-stoplight: id: zdowc6ik9vvcu json_api_relationships_links_folder_parent: title: json_api_relationships_links_folder_parent x-stoplight: id: qmmyfor4fmle9 type: object description: Information on the parent of this resource in the folder hierarchy. properties: links: $ref: '#/components/schemas/json_api_links_related' x-stoplight: id: e35szkgp1o7b8 data: $ref: '#/components/schemas/json_api_type_id' x-stoplight: id: zdowc6ik9vvcu json_api_relationships_links_root_folder: title: json_api_relationships_links_root_folder type: object description: Information about the root folder of a project. properties: meta: $ref: '#/components/schemas/json_api_meta_link' data: $ref: '#/components/schemas/json_api_type_id' json_api_meta_link: title: json_api_meta_link x-stoplight: id: 6c1450io6o3zx type: object description: Meta-information on links to this resource. properties: link: $ref: '#/components/schemas/json_api_link' x-stoplight: id: haazb0d04arzm json_api_relationships_links_only_bim: title: json_api_relationships_links_only_bim x-stoplight: id: 60tg8iovfggh5 type: object description: Contains links to resources that are external to the data domain service. This is available only with BIM360. properties: meta: $ref: '#/components/schemas/json_api_meta_link' x-stoplight: id: xm7qe4jjv1djj data: $ref: '#/components/schemas/json_api_type_id' x-stoplight: id: fcoobatm4empf required: - meta - data json_api_relationships_links_versions: title: json_api_relationships_links_internal x-stoplight: id: da5pz40rvqocl type: object description: Information about the existing versions of the item. properties: links: $ref: '#/components/schemas/json_api_links_related' x-stoplight: id: s7etnb8jkm02f required: - links json_api_relationships_links_internal: title: json_api_relationships_links_internal x-stoplight: id: da5pz40rvqocl type: object description: Information on resources that are found under this resource. properties: links: $ref: '#/components/schemas/json_api_links_related' x-stoplight: id: s7etnb8jkm02f required: - links web_view_link: title: web_view_link x-stoplight: id: b0lyf514eksq4 type: object description: An object containing a link that opens the resource in a browser. properties: href: type: string x-stoplight: id: j0xj0hp05wo0l description: The location (URL) of the resource the link points to. required: - href json_api_links_self_and_web_view: title: json_api_links_self_and_web_view x-stoplight: id: go4472ydw5y6e type: object description: Information on links to this resource. required: - self properties: self: $ref: '#/components/schemas/json_api_link' webView: $ref: '#/components/schemas/web_view_link' json_api_relationships_links_refs: type: object required: - links description: Information on other resources that have a custom relationship with this resource. properties: links: type: object required: - self - related description: The object containing information on links of related resources that share a custom relationship with this resource. properties: self: $ref: '#/components/schemas/json_api_link' related: $ref: '#/components/schemas/json_api_link' json_api_relationships_links_links: type: object required: - links description: Information on the link resources found in this resource. properties: links: type: object required: - self description: The object containing information on links to this resource. properties: self: $ref: '#/components/schemas/json_api_link' json_api_relationships_refs: type: object description: | Information on other resources that share a custom relationship with this resource. properties: data: type: array description: 'An array of objects, where each object represents custom relationship. ' items: minItems: 1 type: object properties: type: $ref: '#/components/schemas/type_version' id: type: string description: | A URN indicating the storage location of the version. meta: type: object description: The meta-information describing the custom relationship. required: - refType - direction - extension properties: refType: $ref: '#/components/schemas/reftypes_xref' direction: $ref: '#/components/schemas/metarefs_direction' extension: type: object description: A container of additional properties that extends the default properties of this resource. required: - type - version properties: type: $ref: '#/components/schemas/extension_type_core_xref' version: type: string description: | The version of the type. The current version is ``1.1.0``. data: type: object description: |- The container of the additional properties. The additional properties must follow the schema specified by ``extensions.type`` and ``extensions.version``. Properties that don't follow the schema will be ignored. properties: nestedType: $ref: '#/components/schemas/nested_xref' required: - nestedType required: - type - id - meta required: - data PaginationInfo: title: PaginationInfo x-stoplight: id: izgy4eslaw38w type: object description: 'An object that is returned with responses that can be split across multiple pages. "Next," "Previous," and "First" are available only if the response is split across multiple pages.' properties: self: type: object x-stoplight: id: dc46tnxbc2ulb description: A container for the link to the current page of the response. properties: href: type: string x-stoplight: id: ljxuu5c8q9luz description: A hypertext reference to the location of the referenced resource. first: type: object x-stoplight: id: hnog0slu3ma0c description: A container for the link to the first page of the response. properties: href: type: string x-stoplight: id: g7npt0viv619d description: A hypertext reference to the location of the referenced resource. next: type: object x-stoplight: id: dc46tnxbc2ulb description: A container for the link to the next page of the response. properties: href: type: string x-stoplight: id: ljxuu5c8q9luz description: A hypertext reference to the location of the referenced resource. prev: type: object x-stoplight: id: dc46tnxbc2ulb description: A container for the link to the previous page of the response. properties: href: type: string x-stoplight: id: ljxuu5c8q9luz description: A hypertext reference to the location of the referenced resource. required: - self extension_type_core_xref: type: string x-stoplight: id: b89a9e7482efd enum: - 'xrefs:autodesk.core:Xref' description: 'The type of the relationship. Will always be ``xrefs:autodesk.core:Xref``.' nested_xref: type: string x-stoplight: id: e8d7c1f07c607 enum: - attachment - overlay description: |- The type of the xref, which defines how nested xrefs are handled. Possible values are: - ``attachment``: Nested xrefs are not ignored. - ``overlay`` : Nested xrefs are ignored. metarefs_direction: type: string x-stoplight: id: 506556039042a enum: - from - to description: |- Describes the direction of data flow in the relationship. Possible values are: - ``to`` - Data flows from this resource to the related resource. - ``from`` - Data flows from the related resource to this resource. conformingStatus: type: string enum: - NONE - CONFORMING - NON_CONFORMING description: | A status indicating whether this version conforms to its parent folder's file naming standard. Possible values: - ``NONE``: The conforming status is not applicable for the version. - ``CONFORMING``: The version conforms to its parent folder's file naming standard. - ``NON_CONFORMING``: The version does not conform to its parent folder's file naming standard. In the event of a ``NON_CONFORMING`` status, use the [Get a Folder](/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-GET) operation to get the file naming standards IDs that have been applied to the version's parent folder. Then use the ID to call [GET naming-standards](/en/docs/bim360/v1/reference/http/document-management-naming-standards-id-GET/) to get the details of the file naming standard. Note that this feature is only available for BIM 360 projects. To learn more about the file naming standard feature, see the [BIM 360 File Naming Standard](https://help.autodesk.com/view/BIM360D/ENU/?guid=Common_Data_Environment) help documentation. project_type_bim360_acc: type: string enum: - BIM360 - ACC description: The type of project. Only relevant for BIM 360 and ACC projects. region: type: string enum: - US - EMEA - AUS - CAN - DEU - IND - JPN - GBR x-stoplight: id: qy609yu6fbfsf description: |- Specifies where the hub is stored. Possible values are: - ``US`` - Data center for the US region. - ``EMEA`` - Data center for the European Union, Middle East, and Africa regions. - ``AUS`` - Data center for the Australia region. - ``CAN`` - Data center for the Canada region. - ``DEU`` - Data center for the Germany region. - ``IND`` - Data center for the India region. - ``JPN`` - Data center for the Japan region. - ``GBR`` - Data center for the United Kingdom region. reftypes_xref: type: string enum: - xrefs description: The type of custom relationship. Will always be ``xrefs``. type_entity: type: string enum: - folders - items - versions description: 'The type of the resource. Possible values are ``folders``, ``items``, ``versions``.' type_folder: type: string enum: - folders description: The type of the resource. Possible values are ``folders``. type_folder_items: type: string enum: - folders - items description: 'The type of the resource. Possible values are ``folders``, ``items``.' type_folder_items_for_storage: type: string x-stoplight: id: cfr71euvqg9jb enum: - folders - items description: | The type of resource the storage location is related to. Possible values are: - ``folders`` - The storage location is for a new item. - ``items`` - The storage location is for a new version of an existing item. type_hub: type: string x-stoplight: id: f84280dd62b59 enum: - hubs description: The type of the resource. Possible values are ``hubs``. type_item: type: string enum: - items description: The type of the resource. Possible values are ``items``. type_link: type: string x-stoplight: id: f84280dd62b59 enum: - links description: The type of the resource. Possible values are ``links``. type_project: type: string x-stoplight: id: f84280dd62b59 enum: - projects description: The type of the resource. Possible values are ``projects``. type_ref: type: string enum: - derived - dependencies - auxiliary - xrefs - includes description: 'The type of the resource. Possible values are ``derived``, ``dependencies``, ``auxiliary``, ``xrefs``, and ``includes``.' type_version: type: string x-stoplight: id: f8e280dd63a5b enum: - versions description: The type of the resource. Possible values are ``versions``. type_object: type: string enum: - objects description: The type of this resource. Possible values are ``objects``. type_downloadformats: type: string x-stoplight: id: shcfu6n1ys7jj enum: - downloadFormats description: The type of this resource. Possible values are ``downloadFormats``. type_downloads: type: string x-stoplight: id: sxvvrm7e0pm4r enum: - downloads description: The type of this resource. Possible values are ``downloads``. type_job: type: string x-stoplight: id: 3h21lnid5ruxu enum: - downloads description: The type of this resource. Possible values are ``jobs``. type_commandtype_publishmodel: type: string x-stoplight: id: 592celhicrm0j enum: - 'commands:autodesk.bim360:C4RModelPublish' description: 'The Type ID of the schema used for extending properties. Must be ``commands:autodesk.bim360:C4RModelPublish`` for the PublishModel command.' title: '' type_commandtype_PublishWithoutLinks: type: string x-stoplight: id: tkmblkn2zi5z0 enum: - 'commands:autodesk.bim360:C4RPublishWithoutLinks' description: 'The Type ID of the schema used for extending properties. Must be ``commands:autodesk.bim360:C4RPublishWithoutLinks`` for the PublishWithoutLinks command.' title: '' type_commandtype_CheckPermission: type: string x-stoplight: id: 0yup2qfa5lihf enum: - 'commands:autodesk.core:CheckPermission' description: 'The Type ID of the schema used for extending properties. Must be ``commands:autodesk.core:CheckPermission`` for the CheckPermission command.' title: '' type_commandtype_ListRefs: type: string x-stoplight: id: nr8yl9km15c8s enum: - 'commands:autodesk.core:ListRefs' description: 'The Type ID of the schema used for extending properties. Must be ``commands:autodesk.core:ListRefs`` for the ListRefs command.' title: '' type_commandtype_ListItems: type: string x-stoplight: id: mln4sd1awtdwu enum: - 'commands:autodesk.core:ListItems' description: 'The Type ID of the schema used for extending properties. Must be ``commands:autodesk.core:ListItems`` for the ListItems command.' title: '' type_commandtype_GetPublishModelJob: type: string x-stoplight: id: cz7rxc7aalsu5 enum: - 'commands:autodesk.bim360:C4RModelGetPublishJob' description: 'The Type ID of the schema used for extending properties. Must be ``commands:autodesk.bim360:C4RModelGetPublishJob`` for the GetPublishModelJob command.' title: '' type_commands: type: string x-stoplight: id: zxlnrf71ucrs0 enum: - commands description: The type of this resource. Possible values are ``commands``. title: '' metaForWebhooks: title: metaForWebhooks x-stoplight: id: x20x6jb3udvzo type: object description: Meta information required for webhooks. properties: workflow: type: string description: | The Workflow ID of a webhook that listens to Model Derivative events. Must be less than 36 characters. Only ASCII characters (a-z, A-Z, 0-9), periods (.), and hyphens (-) are accepted. See the [Creating a Webhook and Listening to Events](/en/docs/webhooks/v1/tutorials/create-a-hook-model-derivative) tutorial for more information. **Note**: This attribute applies to BIM 360 Docs only. workflowAttribute: type: string description: | A user defined JSON object containing custom workflow information for the specified webhook event. Must be less than 1KB. **Note**: Applicable only if a valid value has been specified for ``meta.workflow``. required: - workflow command_execution_status: title: command_execution_status x-stoplight: id: xklprqge1hu7k type: string enum: - accepted - committed - complete - failed description: |- The current stage of the command execution process. Possible values: - ``accepted`` - The command is ready to be executed. - ``committed`` - The command is currently being executed. - ``complete`` - The command was successfully executed. - ``failed`` - There was an error and command execution was stopped prematurely. filter_type: type: string enum: - folders - items description: Filter by the type of the objects in the folder. Supported values are ``folders`` and ``items``. filter_type_internal: type: array items: $ref: '#/components/schemas/filter_type' description: Filter by the type of the objects in the folder. Supported values are ``folders`` and ``items``. filter_type_version: type: string enum: - folders - items - versions description: 'Filter by the ``type`` of the ``ref`` target. Supported values include ``folders``, ``items``, and ``versions``.' filter_type_version_internal: type: array items: $ref: '#/components/schemas/filter_type_version' description: 'Filter by the ``type`` of the ``ref`` target. Supported values include ``folders``, ``items``, and ``versions``.' filter_refType: type: string enum: - derived - dependencies - auxiliary - xrefs - includes description: 'Filter by ``refType``. Possible values: ``derived``, ``dependencies``, ``auxiliary``, ``xrefs``, and ``includes``.' filter_direction: type: string enum: - from - to description: 'Filter by the direction of the reference. Possible values: ``from`` and ``to``.' Command: type: object description: Commamd response properties: jsonapi: $ref: '#/components/schemas/json_api_version' x-stoplight: id: u1z9qa2nxwbah data: x-stoplight: id: jprem0an0kdj0 description: 'The ``data`` object that is returned will be one of the following, depending on the command that was executed.' oneOf: - $ref: '#/components/schemas/CheckPermission' x-stoplight: id: 34h93kxobmo5c - $ref: '#/components/schemas/PublishModel' x-stoplight: id: dv3pscfpo5igu - $ref: '#/components/schemas/PublishWithoutLinks' x-stoplight: id: gyksyybvdyv1a - $ref: '#/components/schemas/PublishModelJob' x-stoplight: id: alclrvbe4wlns - $ref: '#/components/schemas/ListRefs' x-stoplight: id: mbmbxf6rur636 - $ref: '#/components/schemas/ListItems' x-stoplight: id: 567bnr2jj15ns discriminator: propertyName: attributes/extension/type mapping: 'commands:autodesk.core:CheckPermission': '#/components/schemas/CheckPermission' 'commands:autodesk.bim360:C4RModelPublish': '#/components/schemas/PublishModel' 'commands:autodesk.bim360:C4RPublishWithoutLinks': '#/components/schemas/PublishWithoutLinks' 'commands:autodesk.bim360:C4RModelGetPublishJob': '#/components/schemas/PublishModelJob' 'commands:autodesk.core:ListRefs': '#/components/schemas/ListRefs' 'commands:autodesk.core:ListItems': '#/components/schemas/ListItems' CommandPayload: description: Command Payload type: object properties: jsonapi: $ref: '#/components/schemas/json_api_version' x-stoplight: id: 96m2c2hl7kv9e data: x-stoplight: id: m8v239umu1y8b oneOf: - $ref: '#/components/schemas/CheckPermissionPayload' x-stoplight: id: il5xhl47n31aw - $ref: '#/components/schemas/PublishModelPayload' x-stoplight: id: dv3pscfpo5igu - $ref: '#/components/schemas/PublishWithoutLinksPayload' x-stoplight: id: gyksyybvdyv1a - $ref: '#/components/schemas/PublishModelJobPayload' x-stoplight: id: bndi9i0mycesx - $ref: '#/components/schemas/ListRefsPayload' x-stoplight: id: h4qn1w0kjjy4s - $ref: '#/components/schemas/ListItemsPayload' x-stoplight: id: 34h93kxobmo5c description: Pick one of the following data objects to capture the input data for the command you want to execute. CreatedItem: title: CreatedItem description: Create item response type: object properties: jsonapi: $ref: '#/components/schemas/json_api_version' links: $ref: '#/components/schemas/json_api_links_self' data: $ref: '#/components/schemas/ItemData' included: type: array description: An object containing information about the tip version of this item. items: $ref: '#/components/schemas/VersionData' meta: type: object description: The object containing the information on the command ID of the command processor. properties: bim360DmCommandId: type: string x-stoplight: id: i8pl226xnlkcx description: | The command id of the command processor. You can use this ID to check the status of processing. downloads_status: title: downloads status x-stoplight: id: nhgyywqzurg06 description: | The type of this resource. Possible values: queued, finished, failed, processing enum: - queued - finished - failed - processing parameters: hub_id: name: hub_id in: path schema: type: string description: The unique identifier of a hub. required: true x-user-id: name: x-user-id in: header required: false schema: type: string description: 'In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this header, the API call will be limited to act only on behalf of the specified user.' filter_id: name: 'filter[id]' in: query required: false schema: type: array items: type: string description: Filter by the ``id`` of the ``ref`` target. filter_extension_type: name: 'filter[extension.type]' in: query required: false schema: type: array items: type: string description: | Filter by the extension type. page_number: name: 'page[number]' in: query required: false schema: type: integer format: int32 description: Specifies what page to return. Page numbers are 0-based (the first page is page 0). page_limit: name: 'page[limit]' in: query required: false schema: type: integer 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. project_id: name: project_id in: path required: true schema: type: string description: | The unique identifier of a project. For 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``. Similarly, 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``. excludeDeleted: name: excludeDeleted in: query required: false schema: type: boolean description: | Specifies whether deleted folders are excluded from the response for BIM 360 Docs projects, when user context is provided. - ``true``: Response excludes deleted folders for BIM 360 Docs projects. - ``false``: (Default) Response will not exclude deleted folders for BIM 360 Docs projects. projectFilesOnly: name: projectFilesOnly in: query required: false schema: type: boolean description: | Specifies what folders and subfolders to return for BIM 360 Docs projects, when user context is provided. - ``true``: Response will be restricted to folder and subfolders containing project files for BIM 360 Docs projects. - ``false``: (Default) Response will include all available folders. folder_id: name: folder_id in: path required: true schema: type: string description: The unique identifier of a folder. If-Modified-Since: name: If-Modified-Since in: header required: false schema: type: string format: date-time description: 'Specify a date in the ``YYYY-MM-DDThh:mm:ss.sz`` format. If the resource has not been modified since the specified date/time, the response will return a HTTP status of 304 without any response body; the ``Last-Modified`` response header will contain the date of last modification.' filter_name: name: 'filter[name]' in: query required: false schema: type: array items: type: string description: Filter by the ``name`` of the ``ref`` target. filter_lastModifiedTimeRollup: name: 'filter[lastModifiedTimeRollup]' in: query required: false schema: type: array items: type: string description: 'Filter by the ``lastModifiedTimeRollup`` attribute. Supported values are date-time string in the form ``YYYY-MM-DDTHH:MM:SS.000000Z`` or ``YYYY-MM-DDTHH:MM:SS`` based on RFC3339.' filter_type: name: 'filter[type]' in: query required: false schema: $ref: '#/components/schemas/filter_type_internal' description: Filter by the type of the objects in the folder. Supported values are ``folders`` and ``items``. includeHidden: name: includeHidden in: query required: false schema: type: boolean description: | ``true``: Response will contain items and folders that were deleted from BIM 360 Docs projects. ``false``: (Default): Response will not contain items and folders that were deleted from BIM 360 Docs projects. To return only items and folders that were deleted from BIM 360 Docs projects, see the documentation on [Filtering](/en/docs/data/v2/overview/filtering/). filter: name: 'filter[*]' in: query required: false schema: type: array items: type: string description: 'Filter the data. See the [Filtering](/en/docs/data/v2/overview/filtering/) section for details.' filter_refType: name: 'filter[refType]' in: query required: false schema: $ref: '#/components/schemas/filter_refType' description: 'Filter by ``refType``. Possible values: ``derived``, ``dependencies``, ``auxiliary``, ``xrefs``, and ``includes``.' filter_type_version: name: 'filter[type]' in: query required: false schema: $ref: '#/components/schemas/filter_type_version_internal' description: 'Filter by the ``type`` of the ``ref`` target. Supported values include ``folders``, ``items``, and ``versions``.' filter_direction: name: 'filter[direction]' in: query required: false schema: $ref: '#/components/schemas/filter_direction' description: 'Filter by the direction of the reference. Possible values: ``from`` and ``to``.' item_id: name: item_id in: path required: true schema: type: string description: The unique identifier of an item. includePathInProject: name: includePathInProject in: query required: false schema: type: boolean description: | Specify whether to return ``pathInProject`` attribute in response for BIM 360 Docs projects. ``pathInProject`` is the relative path of the item starting from project’s root folder. - ``true``: Response will include the ``pathInProject`` attribute for BIM 360 Docs projects. - ``false``: (Default) Response will not include ``pathInProject`` attribute for BIM 360 Docs projects. filter_versionNumber: name: 'filter[versionNumber]' in: query required: false schema: type: array items: type: integer description: Filter by versionNumber. version_id: name: version_id in: path required: true schema: type: string description: The URL encoded unique identifier of a version. job_id: name: job_id in: path required: true schema: type: string description: The unique identifier of a job. download_id: name: download_id in: path required: true schema: type: string description: The Job ID of the job used to generate the download. filter_format_fileType: name: 'filter[format.fileType]' in: query required: false schema: type: array items: type: string description: Filter by the file type of the download object. copyFrom: name: copyFrom in: query required: false schema: type: string description: | The Version ID (URN) of the version to copy from. **Note**: This parameter is relevant only for copying files to BIM 360 Docs. For information on how to find the URN, see the initial steps of the [Download a File](/en/docs/data/v2/tutorials/download-file/) tutorial. You can only copy files to the Plans folder or to subfolders of the Plans folder with an ``item:autodesk.bim360:Document`` item extension type. You can only copy files to the Project Files folder or to subfolders of the Project Files folder with an ``item:autodesk.bim360:File`` item extension type. To verify an item’s extension type, use the [Get an Item](/en/docs/data/v2/reference/http/projects-project_id-items-item_id-GET/) operation, and check the ``attributes.extension.type`` attribute. Note that if you copy a file to the Plans folder or to a subfolder of the Plans folder, the copied file inherits the permissions of the source file. For example, if users of your app did not have permission to download files in the source folder, but does have permission to download files in the target folder, they will not be able to download the copied file. Note that you cannot copy a file while it is being uploaded, updated, or copied. To verify the current process state of a file, call the [Get an Item](en/docs/data/v2/reference/http/projects-project_id-items-item_id-GET/) operation , and check the ``attributes.extension.data.processState`` attribute. responses: 401-general: description: The supplied Authorization header was not valid or the supplied token scope was not acceptable. Verify Authentication and try again. content: application/json: schema: properties: id: type: string 403-general: description: 'The request was successfully validated but permission is not granted, or the application has not been allowed access. Do not try again unless you resolve permissions first.' content: application/json: schema: type: object x-examples: Example 1: jsonapi: {} links: {} data: [] meta: warnings: - Id: null HttpStatusCode: '403' ErrorCode: BIM360DM_ERROR Title: Unable to get hubs from BIM360DM APAC. Detail: You don't have permission to access this API AboutLink: null Source: null meta: null properties: jsonapi: type: object description: The JSON API object. links: type: object description: 'An object intended to contain the URI of a resource. Empty in this case, because an error has occurred.' data: type: array description: 'An object intended to contain the return data. Empty in this case, because an error has occurred.' items: type: object meta: type: object description: Contains information about the error that occurred. properties: warnings: type: array description: 'An array of objects, where each element of the array represents a warning.' items: type: object properties: Id: description: An ID assigned to the warning. nullable: true HttpStatusCode: type: string description: The HTTP status code returned in response to the request. ErrorCode: type: string description: A code that indicates what went wrong. Title: type: string description: 'A quick summary of the issue, at a glance.' Detail: type: string description: 'A more comprehensive explanation of the issue, providing specific information and potential solutions, if any.' AboutLink: description: A hyperlink to documentation about the issue. nullable: true Source: description: Information about the service that detected the issue. nullable: true meta: description: Additional information about the issue. nullable: true 400-general: description: The request could not be understood by the server due to malformed syntax or missing request headers. The client SHOULD NOT repeat the request without modifications. The response body may give an indication of what is wrong with the request. content: application/json: schema: properties: id: type: string 404-general: description: The specified resource was not found. content: application/json: schema: properties: id: type: string 304-general: description: The specified resource has not been modified since. content: application/json: schema: properties: id: type: string 423-general: description: The source or destination resource is locked or being modified. content: application/json: schema: properties: id: type: string 409-general: description: The specified resource already exists or has been modified. content: application/json: schema: properties: id: type: string command-response: description: The command was executed succesfully. content: application/json: schema: type: object properties: jsonapi: $ref: '#/components/schemas/json_api_version' x-stoplight: id: f3jjya6mnp6jy data: x-stoplight: id: fuihb4amx5f0u oneOf: - $ref: '#/components/schemas/ListRefs' x-stoplight: id: nxbpop5wdkpgw - $ref: '#/components/schemas/CheckPermissionPayload' x-stoplight: id: kc6zvn5vu76i3 description: 'The ``data`` object that is returned will be one of the following, depending on the command that was executed.' tags: - name: Commands - name: Folders - name: Hubs - name: Items - name: Projects - name: Versions