Field Squared API Services

<back to all web services

PortalFile

Contains the data for a PortalFile within the system

The following routes are available for this service:
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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Contains the data for a PortalFile within the system
    */
    public static class PortalFile
    {
        public String ObjectId = null;
        public String Workspace = null;
        public String Name = null;
        public String Teams = null;
        public Boolean Enabled = null;
        public String FileId = null;
        public String ParentFolderId = null;
        public FileStream FileStream = null;
        public MemoryStream BinaryStream = null;
        public String MimeType = null;
        public Long FileSize = null;
        public String UploadUserType = null;
        public String UploadedBy = null;
        public String Uploaded = null;
        public String UploadedByName = null;
        
        public String getObjectId() { return ObjectId; }
        public PortalFile setObjectId(String value) { this.ObjectId = value; return this; }
        public String getWorkspace() { return Workspace; }
        public PortalFile setWorkspace(String value) { this.Workspace = value; return this; }
        public String getName() { return Name; }
        public PortalFile setName(String value) { this.Name = value; return this; }
        public String getTeams() { return Teams; }
        public PortalFile setTeams(String value) { this.Teams = value; return this; }
        public Boolean isEnabled() { return Enabled; }
        public PortalFile setEnabled(Boolean value) { this.Enabled = value; return this; }
        public String getFileId() { return FileId; }
        public PortalFile setFileId(String value) { this.FileId = value; return this; }
        public String getParentFolderId() { return ParentFolderId; }
        public PortalFile setParentFolderId(String value) { this.ParentFolderId = value; return this; }
        public FileStream getFileStream() { return FileStream; }
        public PortalFile setFileStream(FileStream value) { this.FileStream = value; return this; }
        public MemoryStream getBinaryStream() { return BinaryStream; }
        public PortalFile setBinaryStream(MemoryStream value) { this.BinaryStream = value; return this; }
        public String getMimeType() { return MimeType; }
        public PortalFile setMimeType(String value) { this.MimeType = value; return this; }
        public Long getFileSize() { return FileSize; }
        public PortalFile setFileSize(Long value) { this.FileSize = value; return this; }
        public String getUploadUserType() { return UploadUserType; }
        public PortalFile setUploadUserType(String value) { this.UploadUserType = value; return this; }
        public String getUploadedBy() { return UploadedBy; }
        public PortalFile setUploadedBy(String value) { this.UploadedBy = value; return this; }
        public String getUploaded() { return Uploaded; }
        public PortalFile setUploaded(String value) { this.Uploaded = value; return this; }
        public String getUploadedByName() { return UploadedByName; }
        public PortalFile setUploadedByName(String value) { this.UploadedByName = value; return this; }
    }

}

Java PortalFile DTOs

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

HTTP + 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>