Field Squared API Services

<back to all web services

DocumentBatch

Returns a set of documents based on a set of domain items

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

/** @description Returns a set of documents based on a set of domain items */
export class DocumentBatch
{
    public Workspace: string;
    public Items: Object[];
    public OwnerSchemaData: boolean;

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

TypeScript DocumentBatch 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}/DocumentBatch HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Workspace":"String","Items":[{}],"OwnerSchemaData":false}