Field Squared API Services

<back to all web 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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * 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}.
    */
    public static class Image
    {
        public String Workspace = null;
        public String ObjectId = null;
        
        public String getWorkspace() { return Workspace; }
        public Image setWorkspace(String value) { this.Workspace = value; return this; }
        public String getObjectId() { return ObjectId; }
        public Image setObjectId(String value) { this.ObjectId = value; return this; }
    }

}

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