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}
Image Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
ObjectIdpathstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

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