Field Squared API Services

Image

Service representing an Image in a workspace. Note that it's
not necessary to include the Workspace and ObjectId in the POST request body
despite what the auto generated documentation says. These values are taken from
the endpoint itself. Also, during GET, the Accept Type in the request needs to be
populated and needs to match the existing content type stored against the image.
To GET a resized image, use Image/{ObjectId}?maxHeight={3}&maxWidth={4}.
To resize an image during POST, use Image/{ObjectId}?maxHeight={3}&maxWidth={4}.

The following routes are available for this service:
GET,POST,DELETE	/{Workspace}/Image/{ObjectId}

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 Image:
    """
    Service representing an Image in a workspace.  Note that it's not necessary to include the Workspace and ObjectId in the POST request body despite what the auto generated documentation says.  These values are taken from the endpoint itself.  Also, during GET, the Accept Type in the request needs to be populated and needs to match the existing content type stored against the image. To GET a resized image, use Image/{ObjectId}?maxHeight={3}&maxWidth={4}.To resize an image during POST, use Image/{ObjectId}?maxHeight={3}&maxWidth={4}.
    """

    workspace: Optional[str] = None
    object_id: Optional[str] = None

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

{"Workspace":"String","ObjectId":"String"}