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

namespace Field2Office.API.Model.Documents

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

    ///<summary>
    ///Bulk import a set of sub-documents from a file.
    ///</summary>
    [<AllowNullLiteral>]
    type DocumentSubImport() = 
        member val Workspace:String = null with get,set
        member val Id:String = null with get,set
        member val Type:String = null with get,set
        member val SubType:String = null with get,set
        member val OwnerClass:String = null with get,set
        member val OwnerId:String = null with get,set
        member val Mappings:Dictionary<String, String> = new Dictionary<String, String>() with get,set
        member val Delimiter:String = null with get,set

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