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
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* 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.
*/
open class Search
{
    var Workspace:String? = null
    var DateGenerated:String? = null
    var Results:ArrayList<NamedItem> = ArrayList<NamedItem>()
}

open class NamedItem
{
    var Workspace:String? = null
    var ObjectId:String? = null
    var Class:String? = null
    var VersionId:String? = null
    var Name:String? = null
    var LastUpdated:String? = null
}

Kotlin Search 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.

GET /{Workspace}/Search HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv