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

namespace Field2Office.API.Model.Documents
{
    ///<summary>
    ///Bulk import a set of documents from a file.
    ///</summary>
    public partial class DocumentImport
    {
        public DocumentImport()
        {
            Mappings = new Dictionary<string, string>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string Id { get; set; }
        public virtual string Type { get; set; }
        public virtual string OwnerClass { get; set; }
        public virtual string OwnerId { get; set; }
        public virtual Dictionary<string, string> Mappings { get; set; }
        public virtual string Delimiter { get; set; }
    }

}

C# 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
}