topic Re: How to get subfolders via the REST API in Windchill Customization

How to get subfolders via the REST API

AdamElkins — Wed, 20 Nov 2024 15:24:57 GMT

Version: Windchill 12.1

Use Case: I need to traverse the folder structure in a Windchill Library via the REST API's

Description:

I see there are a few relevant API's.

"/v6/DataAdmin/Containers('"+containerId+"')/Folders" provides us with a way to get the root folder, which I believe is pretty much always "/Default", but how do I get the list of folders in that folder, to recursively traverse the folder structure?

I see there is "/v6/DataAdmin/Containers('"+containerId+"')/Folders('"+folderId+"')" but that only gives me the information about the folder I already have the ID for and does not tell me what subfolders exist in that folder.

Re: How to get subfolders via the REST API

tm-4 — Tue, 26 Nov 2024 22:45:14 GMT

Hi,

You need to use the '$expand' param. You need to build the expand param based on the level of the folder structure.

Example:

In this case the folder path is "/default/MyFolder"

Thanks,

Thiagarajan

Re: How to get subfolders via the REST API

anursingh — Wed, 18 Dec 2024 19:11:37 GMT

Hi @AdamElkins,

I wanted to see if you got the help you needed.

If so, please mark the appropriate reply as the Accepted Solution. It will help other members who may have the same question.
Of course, if you have more to share on your issue, please pursue the conversation.

Thanks,
Anurag

Re: How to get subfolders via the REST API

AdamElkins — Wed, 18 Dec 2024 19:17:04 GMT

Still looking into it, thanks.

Re: How to get subfolders via the REST API

AdamElkins — Fri, 10 Jan 2025 20:29:42 GMT

I am guessing you are right about the expand parameter, but what you suggested is not working for me. I get a URI is malformed error.

Re: How to get subfolders via the REST API

AdamElkins — Fri, 10 Jan 2025 21:04:01 GMT

In order to get the subfolder in a given folder via the WRS REST API's, include the $expand parameter with a value of "Folders".

This causes the API to include a Folders objects as part of the JSON response and fills in each of the subfolders.

Search the PTC Support site for Windchill REST Services User Guide for more information on the expand parameter.

Re: How to get subfolders via the REST API

AdamElkins — Fri, 10 Jan 2025 21:04:38 GMT

That helped me get to the solution. Thanks Thiagarajan.

Re: How to get subfolders via the REST API

icelynnin — Tue, 11 Mar 2025 16:02:55 GMT

It isn't obvious at all what needs to be done if you need to create a subfolder in one of these nested folders. The Create Folder json request appears not to work no matter what I try,

Re: How to get subfolders via the REST API

AdamElkins — Fri, 14 Mar 2025 01:52:49 GMT

Yeah, I have found there are not a lot of good examples and it can be a challenge to figure out how to do what you need to.

Re: How to get subfolders via the REST API

GB_10984907 — Thu, 22 Jan 2026 21:44:15 GMT

Any idea had to get the contents of the Subfolders? I get errors if I use the ID of the Subfolder.