Field Squared API Services

DocumentImport

Bulk import a set of documents from a file.

The following routes are available for this service:
POST	/{Workspace}/DocumentImport

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentImport:
    """
    Bulk import a set of documents from a file.
    """

    workspace: Optional[str] = None
    id: Optional[str] = None
    type: Optional[str] = None
    owner_class: Optional[str] = None
    owner_id: Optional[str] = None
    mappings: Optional[Dict[str, str]] = None
    delimiter: Optional[str] = None

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