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.*


/**
* Contains the data for a PortalFile within the system
*/
open class PortalFile
{
    var ObjectId:String? = null
    var Workspace:String? = null
    var Name:String? = null
    var Teams:String? = null
    var Enabled:Boolean? = null
    var FileId:String? = null
    var ParentFolderId:String? = null
    var FileStream:FileStream? = null
    var BinaryStream:MemoryStream? = null
    var MimeType:String? = null
    var FileSize:Long? = null
    var UploadUserType:String? = null
    var UploadedBy:String? = null
    var Uploaded:String? = null
    var UploadedByName:String? = null
}

Kotlin 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.