| 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 |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PortalFolder:
"""
Gives access to the PortalFolder Collection within the system
"""
object_id: Optional[str] = None
workspace: Optional[str] = None
name: Optional[str] = None
teams: Optional[List[str]] = None
parent_folder_id: Optional[str] = None
ancestors: Optional[List[str]] = None
enabled: Optional[bool] = None
is_trunk: bool = False
is_valid: bool = False
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<PortalFolder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Workspaces">
<Ancestors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Ancestors>
<Enabled>false</Enabled>
<IsTrunk>false</IsTrunk>
<Name>String</Name>
<ObjectId>String</ObjectId>
<ParentFolderId>String</ParentFolderId>
<Teams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Teams>
<Workspace>String</Workspace>
</PortalFolder>