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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.Documents

Namespace Global

    Namespace Field2Office.API.Model.Documents

        '''<Summary>
        '''Bulk import a set of sub-documents from a file.
        '''</Summary>
        Public Partial Class DocumentSubImport
            Public Sub New()
                Mappings = New Dictionary(Of String, String)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property Id As String
            Public Overridable Property Type As String
            Public Overridable Property SubType As String
            Public Overridable Property OwnerClass As String
            Public Overridable Property OwnerId As String
            Public Overridable Property Mappings As Dictionary(Of String, String)
            Public Overridable Property Delimiter As String
        End Class
    End Namespace
End Namespace

VB.NET 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>