26 Nov 2024
ACC Sheet API Added Endpoints of Reading Collection

ACC Collections enables you to organize the sheets into groups without versioning on top of each other. This allows the scenario with duplicated sheet numbers across different collections within a project. In this release, we exposed two more endpoints to fetch the collections and individual collection.
• GET collections
• GET collections/:collectionId
The same to other endpoints of Sheet API, the two APIs supports authentication of user context(3-legged token) and application context (2-legged token). In addition, both b.projectId and projectId are supported in the request parameter.
Some endpoints add name and id of the associated collection in the response data.
• POST version-sets
• PATCH version-sets/:versionSetId
• POST sheets:batch-get
• POST version-sets:batch-get
In addition, the two endpoints below also add filter to search sheets or version sets by collection. If without filtering, they will only return the ungrouped entities (collection id = null) . if filter collectionId = *, they return all entities of ungrouped or grouped. If collectionId=<specific collection id>, it will return the entities of the specific collection only.
• GET sheets
• GET version sets
The Postman demo scripts is updated accordingly.
https://github.com/autodesk-platform-services/aps-acc-sheet.api-postman.collection
One more note: in the workflow of publishing a sheet, it requires to prepare a version-set. The version-set can be grouped (with collection) or ungrouped. While this release does not cover creating/modifying/deleting collection. It does not either expose the support to create or modify version set with a collection. So if you want to build a code to publish sheets to grouped version-set, you have to create the version-set on ACC web UI first.