| POST | /{Workspace}/PortalFile/Name/{Name}/Folder/{ParentFolderId} | ||
|---|---|---|---|
| POST | /{Workspace}/PortalFile/Rename/{ObjectId}/Name/{Name} | ||
| GET, DELETE | /{Workspace}/PortalFile/{ObjectId} | ||
| GET | /{Workspace}/PortalFile/Search | ||
| GET, DELETE | /{Workspace}/PortalFile/All/{ParentFolderId} | ||
| POST | /{Workspace}/CustomerPortal/File/Name/{Name}/Folder/{ParentFolderId} | ||
| POST | /{Workspace}/CustomerPortal/File/Rename/{ObjectId}/Name/{Name} | ||
| GET, DELETE | /{Workspace}/CustomerPortal/File/{ObjectId} | ||
| GET | /{Workspace}/CustomerPortal/File/Search | ||
| GET, DELETE | /{Workspace}/CustomerPortal/File/All/{ParentFolderId} |
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 PortalFile:
"""
Contains the data for a PortalFile within the system
"""
object_id: Optional[str] = None
workspace: Optional[str] = None
name: Optional[str] = None
teams: Optional[str] = None
enabled: bool = False
file_id: Optional[str] = None
parent_folder_id: Optional[str] = None
file_stream: Optional[FileStream] = None
binary_stream: Optional[MemoryStream] = None
mime_type: Optional[str] = None
file_size: int = 0
upload_user_type: Optional[str] = None
uploaded_by: Optional[str] = None
uploaded: Optional[str] = None
uploaded_by_name: Optional[str] = None
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}/PortalFile/Name/{Name}/Folder/{ParentFolderId} HTTP/1.1
Host: dev.fieldsquared.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PortalFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Workspaces">
<BinaryStream xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.IO">
<__identity i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/System" />
<d2p1:_buffer></d2p1:_buffer>
<d2p1:_capacity>0</d2p1:_capacity>
<d2p1:_expandable>true</d2p1:_expandable>
<d2p1:_exposable>true</d2p1:_exposable>
<d2p1:_isOpen>true</d2p1:_isOpen>
<d2p1:_length>0</d2p1:_length>
<d2p1:_origin>0</d2p1:_origin>
<d2p1:_position>0</d2p1:_position>
<d2p1:_writable>true</d2p1:_writable>
</BinaryStream>
<Enabled>false</Enabled>
<FileId>String</FileId>
<FileSize>0</FileSize>
<FileStream xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
<MimeType>String</MimeType>
<Name>String</Name>
<ObjectId>String</ObjectId>
<ParentFolderId>String</ParentFolderId>
<Teams>String</Teams>
<UploadUserType>String</UploadUserType>
<Uploaded>String</Uploaded>
<UploadedBy>String</UploadedBy>
<UploadedByName>String</UploadedByName>
<Workspace>String</Workspace>
</PortalFile>