Field Squared API Services

<back to all web services

PublicCatalog

The following routes are available for this service:
GET, PUT, POST, DELETE/{Workspace}/API/Catalog/{CatalogType}
GET, PUT, POST, DELETE/{Workspace}/API/Catalog
GET/{Workspace}/API/Catalog/Schema/{CatalogType}
import java.math.*
import java.util.*
import net.servicestack.client.*


@DataContract
open class PublicCatalog
{
    @DataMember
    var Workspace:String? = null

    @DataMember
    var CatalogType:String? = null

    @DataMember
    var Catalog:Catalog? = null

    @DataMember
    var Catalogs:ArrayList<Catalog> = ArrayList<Catalog>()
}

/**
* 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 PublicCatalog 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.

POST /{Workspace}/API/Catalog/{CatalogType} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Workspace":"String","CatalogType":"String","Catalog":{"CatalogType":"String","LastUpdated":"String","Created":"String","Data":{"String":{}}},"Catalogs":[{"CatalogType":"String","LastUpdated":"String","Created":"String","Data":{"String":{}}}]}