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

/** @description Bulk import a set of documents from a file. */
export class DocumentImport
{
    public Workspace: string;
    public Id: string;
    public Type: string;
    public OwnerClass: string;
    public OwnerId: string;
    public Mappings: { [index: string]: string; };
    public Delimiter: string;

    public constructor(init?: Partial<DocumentImport>) { (Object as any).assign(this, init); }
}

TypeScript DocumentImport DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

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