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}
namespace Field2Office.API.Model.Workspaces

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Contains the data for a PortalFile within the system
    ///</summary>
    [<AllowNullLiteral>]
    type PortalFile() = 
        member val ObjectId:String = null with get,set
        member val Workspace:String = null with get,set
        member val Name:String = null with get,set
        member val Teams:String = null with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val FileId:String = null with get,set
        member val ParentFolderId:String = null with get,set
        member val FileStream:FileStream = null with get,set
        member val BinaryStream:MemoryStream = null with get,set
        member val MimeType:String = null with get,set
        member val FileSize:Int64 = new Int64() with get,set
        member val UploadUserType:String = null with get,set
        member val UploadedBy:String = null with get,set
        member val Uploaded:String = null with get,set
        member val UploadedByName:String = null with get,set

F# 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.