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}

/** @description Contains the data for a PortalFile within the system */
export class PortalFile
{
    public ObjectId: string;
    public Workspace: string;
    public Name: string;
    public Teams: string;
    public Enabled: boolean;
    public FileId: string;
    public ParentFolderId: string;
    public FileStream: FileStream;
    public BinaryStream: MemoryStream;
    public MimeType: string;
    public FileSize: number;
    public UploadUserType: string;
    public UploadedBy: string;
    public Uploaded: string;
    public UploadedByName: string;

    public constructor(init?: Partial<PortalFile>) { (Object as any).assign(this, init); }
}

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