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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Bulk import a set of documents from a file.
    */
    public static class DocumentImport
    {
        public String Workspace = null;
        public String Id = null;
        public String Type = null;
        public String OwnerClass = null;
        public String OwnerId = null;
        public HashMap<String,String> Mappings = null;
        public String Delimiter = null;
        
        public String getWorkspace() { return Workspace; }
        public DocumentImport setWorkspace(String value) { this.Workspace = value; return this; }
        public String getId() { return Id; }
        public DocumentImport setId(String value) { this.Id = value; return this; }
        public String getType() { return Type; }
        public DocumentImport setType(String value) { this.Type = value; return this; }
        public String getOwnerClass() { return OwnerClass; }
        public DocumentImport setOwnerClass(String value) { this.OwnerClass = value; return this; }
        public String getOwnerId() { return OwnerId; }
        public DocumentImport setOwnerId(String value) { this.OwnerId = value; return this; }
        public HashMap<String,String> getMappings() { return Mappings; }
        public DocumentImport setMappings(HashMap<String,String> value) { this.Mappings = value; return this; }
        public String getDelimiter() { return Delimiter; }
        public DocumentImport setDelimiter(String value) { this.Delimiter = value; return this; }
    }

}

Java 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
}