Get Folder List

Modified on Wed, 11 Jun at 12:43 PM

Description:

This API will return list of the folders in the repository.

API Endpoint:

/ws/Repository Management

Method:

POST

Header:

Field	Value
SOAPAction	/ws/datasetManagement.wsdl

Request:

XML Element	Type	Value
<wsse:Username>	String	Smarten username
<wsse:Password>	String	Smarten user password
<rep:userName>	String	Smarten user id, you can access it from Smarten Menu – Admin – Security and Permission

Request Example:

<soapenv:Envelope xmlns:rep="http://www.elegantjbi.com/ws/RepositoryManagement" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Header>

<wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">

<wsse:UsernameToken wsu:Id="UsernameToken-91BBA648BD9FD2AB6F169270256917210">

<wsse:Username>username</wsse:Username>

<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>

</wsse:UsernameToken>

</wsse:Security>

</soapenv:Header>

<soapenv:Body>

<rep:getFolderListRequest>

<rep:userName>username</rep:userName>

</rep:getFolderListRequest>

</soapenv:Body>

</soapenv:Envelope>

Response:

Return a response with SOAP XML as object.

XML Element	Type	Value
<ns2:statusCode>	String	Return the API status response
<ns2:folderId>	String	Id of the folder in the repository
<ns2:folderName>	String	Name of the folder in repository
<ns2:folderPath>	String	Path of the folder
<ns2:parentFolderId>	String	Parent folder Id of the folder

Response Example:

SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header>

<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" SOAP-ENV:mustUnderstand="1">

<wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="XWSSGID-1747337693638-1069532304">

<wsse:Username>user</wsse:Username>

<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest">k2CYh5CxGGycWS4c1eKhclmtndA=</wsse:Password>

<wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary">EJwuna7S0VVsUzbX5ZxTyaDZ</wsse:Nonce>

<wsu:Created>2025-05-26T07:35:14.923Z</wsu:Created>

</wsse:UsernameToken>

</wsse:Security>

</SOAP-ENV:Header>

<SOAP-ENV:Body>

<ns2:getFolderListResponse xmlns:ns2="http://www.elegantjbi.com/ws/RepositoryManagement">

<ns2:repository>

<ns2:folderId>folders</ns2:folderId>

<ns2:folderName>Repository</ns2:folderName>

<ns2:description/>

<ns2:parentFolderId/>

<ns2:folderPath>/Repository</ns2:folderPath>

<ns2:folders>

<ns2:folderId>FolderId</ns2:folderId>

<ns2:folderName>FolderName</ns2:folderName>

<ns2:description/>

<ns2:parentFolderId>Parentfolder</ns2:parentFolderId>

<ns2:folderPath>FolderPath</ns2:folderPath>

<ns2:myFolder>

<ns2:folderId>18adabf89f0</ns2:folderId>

<ns2:folderName>myfolder</ns2:folderName>

<ns2:parentFolderId/>

<ns2:folderPath>/myfolder</ns2:folderPath>

</ns2:myFolder>

<ns2:status>

<ns2:statusCode>Success</ns2:statusCode>

</ns2:status>

</ns2:getFolderListResponse>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Postman Example:

You can import the example below into Postman.

curl --location 'https://<SMARTENURL>/smarten/ws/repositoryManagement.wsdl' \

--header 'Content-Type: text/xml' \

--data '<soapenv:Envelope xmlns:rep="http://www.elegantjbi.com/ws/RepositoryManagement" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Header>

<wsse:UsernameToken wsu:Id="UsernameToken-91BBA648BD9FD2AB6F169270256917210">

<wsse:Username>username</wsse:Username>

<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>

</wsse:UsernameToken>

</wsse:Security>

</soapenv:Header>

<soapenv:Body>

<rep:getFolderListRequest>

<rep:userName>username</rep:userName>

</rep:getFolderListRequest>

</soapenv:Body>

</soapenv:Envelope>'

Attachments (1)

json

Get Folder L....json
2.33 KB