Field Squared API Services

<back to all web services

CatalogList

/{Workspace}/CatalogList returns a list of catalogs in the workspace.

The following routes are available for this service:
GET/{Workspace}/CatalogList
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* /{Workspace}/CatalogList returns a list of catalogs in the workspace.
*/
open class CatalogList
{
    var Workspace:String? = null
    var DateGenerated:String? = null
    var Catalogs:ArrayList<Catalog> = ArrayList<Catalog>()
    var RecordsAvailable:Long? = null
}

/**
* Contains the data for a catalog within the system.
*/
open class Catalog
{
    var Workspace:String? = null
    var AssignedWorkspace:String? = null
    var ObjectId:String? = null
    var VersionId:String? = null
    var BasedOn:String? = null
    var ExternalId:String? = null
    var Created:String? = null
    var LastUpdated:String? = null
    var Name:String? = null
    var Type:String? = null
    var Parent:String? = null
    var Ancestors:ArrayList<String> = ArrayList<String>()
    var Items:HashMap<String,HashMap<String,String>> = HashMap<String,HashMap<String,String>>()
    var Enabled:Boolean? = null
}

Kotlin CatalogList DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /{Workspace}/CatalogList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv