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
namespace Field2Office.API.Model

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type NamedItem() = 
        member val Workspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val Class:String = null with get,set
        member val VersionId:String = null with get,set
        member val Name:String = null with get,set
        member val LastUpdated:String = null with get,set

    ///<summary>
    ///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.
    ///</summary>
    [<AllowNullLiteral>]
    type Search() = 
        member val Workspace:String = null with get,set
        member val DateGenerated:String = null with get,set
        member val Results:ResizeArray<NamedItem> = new ResizeArray<NamedItem>() with get,set

F# 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