Field Squared API 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}

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 ImageList:
    """
    Service representing an image list request in a workspace. Returns a .ZIP file containing all the images in the request.
    """

    workspace: Optional[str] = None
    image_ids: Optional[List[str]] = None
    document_id: Optional[str] = None

Python 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"}