Field Squared API Services

<back to all web 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

/** @description Gives access to the PortalFolder Collection within the system */
export class PortalFolder
{
    public ObjectId: string;
    public Workspace: string;
    public Name: string;
    public Teams: string[];
    public ParentFolderId: string;
    public Ancestors: string[];
    public Enabled?: boolean;
    public IsTrunk: boolean;
    public IsValid: boolean;

    public constructor(init?: Partial<PortalFolder>) { (Object as any).assign(this, init); }
}

TypeScript PortalFolder DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

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