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 Foundation
import ServiceStack

/**
* Contains the data for a PortalFile within the system
*/
public class PortalFile : Codable
{
    public var objectId:String
    public var workspace:String
    public var name:String
    public var teams:String
    public var enabled:Bool
    public var fileId:String
    public var parentFolderId:String
    public var fileStream:FileStream
    public var binaryStream:MemoryStream
    public var mimeType:String
    public var fileSize:Int
    public var uploadUserType:String
    public var uploadedBy:String
    public var uploaded:String
    public var uploadedByName:String

    required public init(){}
}

Swift PortalFile DTOs

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

HTTP + CSV

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

{Unable to show example output for type 'PortalFile' using the custom 'csv' filter}One or more errors occurred.