Field Squared API Services

DocumentSubImport

Bulk import a set of sub-documents from a file.

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

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 DocumentSubImport:
    """
    Bulk import a set of sub-documents from a file.
    """

    workspace: Optional[str] = None
    id: Optional[str] = None
    type: Optional[str] = None
    sub_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 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>