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 'package:servicestack/servicestack.dart';

/**
* Contains the data for a PortalFile within the system
*/
class PortalFile implements IConvertible
{
    String? ObjectId;
    String? Workspace;
    String? Name;
    String? Teams;
    bool? Enabled;
    String? FileId;
    String? ParentFolderId;
    FileStream? FileStream;
    MemoryStream? BinaryStream;
    String? MimeType;
    int? FileSize;
    String? UploadUserType;
    String? UploadedBy;
    String? Uploaded;
    String? UploadedByName;

    PortalFile({this.ObjectId,this.Workspace,this.Name,this.Teams,this.Enabled,this.FileId,this.ParentFolderId,this.FileStream,this.BinaryStream,this.MimeType,this.FileSize,this.UploadUserType,this.UploadedBy,this.Uploaded,this.UploadedByName});
    PortalFile.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ObjectId = json['ObjectId'];
        Workspace = json['Workspace'];
        Name = json['Name'];
        Teams = json['Teams'];
        Enabled = json['Enabled'];
        FileId = json['FileId'];
        ParentFolderId = json['ParentFolderId'];
        FileStream = JsonConverters.fromJson(json['FileStream'],'FileStream',context!);
        BinaryStream = JsonConverters.fromJson(json['BinaryStream'],'MemoryStream',context!);
        MimeType = json['MimeType'];
        FileSize = json['FileSize'];
        UploadUserType = json['UploadUserType'];
        UploadedBy = json['UploadedBy'];
        Uploaded = json['Uploaded'];
        UploadedByName = json['UploadedByName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ObjectId': ObjectId,
        'Workspace': Workspace,
        'Name': Name,
        'Teams': Teams,
        'Enabled': Enabled,
        'FileId': FileId,
        'ParentFolderId': ParentFolderId,
        'FileStream': JsonConverters.toJson(FileStream,'FileStream',context!),
        'BinaryStream': JsonConverters.toJson(BinaryStream,'MemoryStream',context!),
        'MimeType': MimeType,
        'FileSize': FileSize,
        'UploadUserType': UploadUserType,
        'UploadedBy': UploadedBy,
        'Uploaded': Uploaded,
        'UploadedByName': UploadedByName
    };

    getTypeName() => "PortalFile";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'dev.fieldsquared.com', types: <String, TypeInfo> {
    'PortalFile': TypeInfo(TypeOf.Class, create:() => PortalFile()),
    'FileStream': TypeInfo(TypeOf.Class, create:() => FileStream()),
    'MemoryStream': TypeInfo(TypeOf.Class, create:() => MemoryStream()),
});

Dart PortalFile DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<PortalFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Workspaces">
  <BinaryStream xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.IO">
    <__identity i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/System" />
    <d2p1:_buffer></d2p1:_buffer>
    <d2p1:_capacity>0</d2p1:_capacity>
    <d2p1:_expandable>true</d2p1:_expandable>
    <d2p1:_exposable>true</d2p1:_exposable>
    <d2p1:_isOpen>true</d2p1:_isOpen>
    <d2p1:_length>0</d2p1:_length>
    <d2p1:_origin>0</d2p1:_origin>
    <d2p1:_position>0</d2p1:_position>
    <d2p1:_writable>true</d2p1:_writable>
  </BinaryStream>
  <Enabled>false</Enabled>
  <FileId>String</FileId>
  <FileSize>0</FileSize>
  <FileStream xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
  <MimeType>String</MimeType>
  <Name>String</Name>
  <ObjectId>String</ObjectId>
  <ParentFolderId>String</ParentFolderId>
  <Teams>String</Teams>
  <UploadUserType>String</UploadUserType>
  <Uploaded>String</Uploaded>
  <UploadedBy>String</UploadedBy>
  <UploadedByName>String</UploadedByName>
  <Workspace>String</Workspace>
</PortalFile>