Field Squared API Services

<back to all web services

ImageList

Service representing an image list request in a workspace.
Returns a .ZIP file containing all the images in the request.

The following routes are available for this service:
POST/{Workspace}/ImageList
GET/{Workspace}/ImageList/{DocumentId}

/** @description Service representing an image list request in a workspace. Returns a .ZIP file containing all the images in the request. */
export class ImageList
{
    public Workspace: string;
    public ImageIds: string[];
    public DocumentId: string;

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

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

{"Workspace":"String","ImageIds":["String"],"DocumentId":"String"}