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}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.Workspaces;

namespace Field2Office.API.Model.Workspaces
{
    ///<summary>
    ///Contains the data for a PortalFile within the system
    ///</summary>
    public partial class PortalFile
    {
        public virtual string ObjectId { get; set; }
        public virtual string Workspace { get; set; }
        public virtual string Name { get; set; }
        public virtual string Teams { get; set; }
        public virtual bool Enabled { get; set; }
        public virtual string FileId { get; set; }
        public virtual string ParentFolderId { get; set; }
        public virtual FileStream FileStream { get; set; }
        public virtual MemoryStream BinaryStream { get; set; }
        public virtual string MimeType { get; set; }
        public virtual long FileSize { get; set; }
        public virtual string UploadUserType { get; set; }
        public virtual string UploadedBy { get; set; }
        public virtual string Uploaded { get; set; }
        public virtual string UploadedByName { get; set; }
    }

}

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