Field Squared API Services

<back to all web services

DocumentSubImport

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

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

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

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