Field Squared API Services

<back to all web services

DocumentImport

Bulk import a set of documents from a file.

The following routes are available for this service:
POST/{Workspace}/DocumentImport
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 documents from a file.
    ///</summary>
    [<AllowNullLiteral>]
    type DocumentImport() = 
        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 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# DocumentImport DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/DocumentImport HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	Id: String,
	Type: String,
	OwnerClass: String,
	OwnerId: String,
	Mappings: 
	{
		String: String
	},
	Delimiter: String
}