Field Squared API Services

DocumentSubImport

Bulk import a set of sub-documents from a file.

The following routes are available for this service:
POST	/{Workspace}/DocumentSubImport

import 'package:servicestack/servicestack.dart';

/**
* Bulk import a set of sub-documents from a file.
*/
class DocumentSubImport implements IConvertible
{
    String? Workspace;
    String? Id;
    String? Type;
    String? SubType;
    String? OwnerClass;
    String? OwnerId;
    Map<String,String?>? Mappings;
    String? Delimiter;

    DocumentSubImport({this.Workspace,this.Id,this.Type,this.SubType,this.OwnerClass,this.OwnerId,this.Mappings,this.Delimiter});
    DocumentSubImport.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Workspace = json['Workspace'];
        Id = json['Id'];
        Type = json['Type'];
        SubType = json['SubType'];
        OwnerClass = json['OwnerClass'];
        OwnerId = json['OwnerId'];
        Mappings = JsonConverters.toStringMap(json['Mappings']);
        Delimiter = json['Delimiter'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Workspace': Workspace,
        'Id': Id,
        'Type': Type,
        'SubType': SubType,
        'OwnerClass': OwnerClass,
        'OwnerId': OwnerId,
        'Mappings': Mappings,
        'Delimiter': Delimiter
    };

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

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

Dart DocumentSubImport 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}/DocumentSubImport HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DocumentSubImport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Documents">
  <Delimiter>String</Delimiter>
  <Id>String</Id>
  <Mappings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Mappings>
  <OwnerClass>String</OwnerClass>
  <OwnerId>String</OwnerId>
  <SubType>String</SubType>
  <Type>String</Type>
  <Workspace>String</Workspace>
</DocumentSubImport>