Field Squared API Services

<back to all web services

DocumentSubImport

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

The following routes are available for this service:
POST/{Workspace}/DocumentSubImport
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Bulk import a set of sub-documents from a file.
*/
open class DocumentSubImport
{
    var Workspace:String? = null
    var Id:String? = null
    var Type:String? = null
    var SubType:String? = null
    var OwnerClass:String? = null
    var OwnerId:String? = null
    var Mappings:HashMap<String,String> = HashMap<String,String>()
    var Delimiter:String? = null
}

Kotlin 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>