Field Squared API Services

CatalogList

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

The following routes are available for this service:
GET	/{Workspace}/CatalogList

import Foundation
import ServiceStack

/**
* /{Workspace}/CatalogList returns a list of catalogs in the workspace.
*/
public class CatalogList : Codable
{
    public var workspace:String
    public var dateGenerated:String
    public var catalogs:[Catalog] = []
    public var recordsAvailable:Int

    required public init(){}
}

/**
* Contains the data for a catalog within the system.
*/
public class Catalog : Codable
{
    public var workspace:String
    public var assignedWorkspace:String
    public var objectId:String
    public var versionId:String
    public var basedOn:String
    public var externalId:String
    public var created:String
    public var lastUpdated:String
    public var name:String
    public var type:String
    public var parent:String
    public var ancestors:[String] = []
    public var items:[String:[String:String]] = [:]
    public var enabled:Bool

    required public init(){}
}

Swift 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