Field Squared API Services

PortalFolder

Gives access to the PortalFolder Collection within the system

The following routes are available for this service:
GET,DELETE	/{Workspace}/CustomerPortal/Folder/{ObjectId}
GET	/{Workspace}/CustomerPortal/Folder/All/{ObjectId}
GET	/{Workspace}/CustomerPortal/Folder/Children/{ObjectId}
GET	/{Workspace}/CustomerPortal/Folder/Trunk/Node
GET	/{Workspace}/CustomerPortal/Folder/Trunk/All
GET,DELETE	/{Workspace}/PortalFolder/{ObjectId}
GET	/{Workspace}/PortalFolder/All/{ObjectId}
GET	/{Workspace}/PortalFolder/Children/{ObjectId}
GET	/{Workspace}/PortalFolder/Trunk/Node
GET	/{Workspace}/PortalFolder/Trunk/All
POST	/{Workspace}/PortalFolder/Trunk/{Name}
GET	/{Workspace}/PortalFolder/All/Id/{ObjectId}
GET	/{Workspace}/PortalFolder/Trunk/All/Id
POST	/{Workspace}/PortalFolder/{ParentFolderId}/Name/{Name}
POST	/{Workspace}/PortalFolder
GET	/{Workspace}/CustomerPortal/Folder/All/Id/{ObjectId}
GET	/{Workspace}/CustomerPortal/Folder/Trunk/All/Id
POST	/{Workspace}/CustomerPortal/Folder/{ParentFolderId}/Name/{Name}
POST	/{Workspace}/CustomerPortal/Folder

**PortalFolder** Parameters:
Name	Parameter	Data Type	Required
ObjectId	path	string	No
Workspace	path	string	No
Name	path	string	No
Teams	body	List<string>	No
ParentFolderId	path	string	No
Ancestors	body	List<string>	No
Enabled	body	bool?	No
IsTrunk	body	bool	No
IsValid	body	bool	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/PortalFolder/Trunk/{Name} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ObjectId":"String","Workspace":"String","Name":"String","Teams":["String"],"ParentFolderId":"String","Ancestors":["String"],"Enabled":false,"IsTrunk":false,"IsValid":false}