Welcome to the Onshape forum! Ask questions and join in the discussions about everything Onshape.
First time visiting? Here are some places to start:- Looking for a certain topic? Check out the categories filter or use Search (upper right).
- Need support? Ask a question to our Community Support category.
- Please submit support tickets for bugs but you can request improvements in the Product Feedback category.
- Be respectful, on topic and if you see a problem, Flag it.
If you would like to contact our Community Manager personally, feel free to send a private message or an email.
Creating A folder within a document from the API
Larkin_Dunlop
Member Posts: 5 ✭
Hey Hey,
Currently trying to make a script that monitors for new documents, then formats them as soon as I create them to avoid having to spend 5 mins formatting a doc when I create it.
The structure I am going for involves having folders for parts, drawings, and subassemblies, but I can't seem to find a way to create a folder or make a document within a folder using the API.
Is there a way to do this or am I stuck with manually doing it?
Best Answer
-
Caden_Armstrong
Member Posts: 248 PRO
As far as I know there is no way to make folders inside of documents with the API.
I don't think theres even an API to get the folders or their contents inside documents.
Closest work around I could think of would be to have a template document in your Onshape with the structure you want, and then duplicate that document. But theres no really great way of launching that api call. The document list/info panel contexts require selecting another document - which is both weird and annoying if have an empty folder. Maybe that is less annoying than manually making that document structure.
This is common enough that I'd really like to see Onshape have a "Create > Document from template" option.www.smartbenchsoftware.com --- fs.place --- Renaissance
Custom FeatureScript and Onshape Integrated Applications3
Answers
As far as I know there is no way to make folders inside of documents with the API.
I don't think theres even an API to get the folders or their contents inside documents.
Closest work around I could think of would be to have a template document in your Onshape with the structure you want, and then duplicate that document. But theres no really great way of launching that api call. The document list/info panel contexts require selecting another document - which is both weird and annoying if have an empty folder. Maybe that is less annoying than manually making that document structure.
This is common enough that I'd really like to see Onshape have a "Create > Document from template" option.
Custom FeatureScript and Onshape Integrated Applications
Yep... Ended up coding a whole thing that looked for documents named "Untitled document" (or whatever the default name is) that were created on the same day, then deleting that and copying a template instead, but then, having finished it, I realised it was way more of a pain than just manually copying my template document 😂
I absolutely agree with you on being able to copy document structures/contents between documents without having to create a whole new doc, I could see a few use cases for it.
Thanks for your help, I appreciate it!
Not likely relevant now, but I do want to point out that it is bad practice to loop through documents to look for new ones, you'll hit API limits and waste resources.
If you want a work flow to detect new documents - use a webhook:
https://onshape-public.github.io/docs/app-dev/webhook/
Custom FeatureScript and Onshape Integrated Applications
Oh perfect, was looking for something like that, but obv didn't look hard enough. Thanks!