Field Squared API Services

<back to all web services

Search

This service needs to be called with a query filter. It will fail otherwise.
Usage is /{Workspace}/Search?QUERY=John Smith (where John Smith is the text query to use for the search).
CLASSES=classlist (where classlist is an optional comma separated list of classes to search. i.e. Document,Task,Contact,Feedback
If this parameter is not specified, all classes are searched.

The following routes are available for this service:
GET/{Workspace}/Search
Search Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
DateGeneratedquerystringNo
ResultsqueryList<NamedItem>No
NamedItem Parameters:
NameParameterData TypeRequiredDescription
WorkspaceformstringNo
ObjectIdformstringNo
ClassformstringNo
VersionIdformstringNo
NameformstringNo
LastUpdatedformstringNo

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.

GET /{Workspace}/Search HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json