Field Squared API Services

<back to all web services

Catalog

Contains the data for a catalog within the system.

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

public class dtos
{

    /**
    * Contains the data for a catalog within the system.
    */
    public static class Catalog
    {
        public String Workspace = null;
        public String AssignedWorkspace = null;
        public String ObjectId = null;
        public String VersionId = null;
        public String BasedOn = null;
        public String ExternalId = null;
        public String Created = null;
        public String LastUpdated = null;
        public String Name = null;
        public String Type = null;
        public String Parent = null;
        public ArrayList<String> Ancestors = null;
        public HashMap<String,HashMap<String,String>> Items = null;
        public Boolean Enabled = null;
        
        public String getWorkspace() { return Workspace; }
        public Catalog setWorkspace(String value) { this.Workspace = value; return this; }
        public String getAssignedWorkspace() { return AssignedWorkspace; }
        public Catalog setAssignedWorkspace(String value) { this.AssignedWorkspace = value; return this; }
        public String getObjectId() { return ObjectId; }
        public Catalog setObjectId(String value) { this.ObjectId = value; return this; }
        public String getVersionId() { return VersionId; }
        public Catalog setVersionId(String value) { this.VersionId = value; return this; }
        public String getBasedOn() { return BasedOn; }
        public Catalog setBasedOn(String value) { this.BasedOn = value; return this; }
        public String getExternalId() { return ExternalId; }
        public Catalog setExternalId(String value) { this.ExternalId = value; return this; }
        public String getCreated() { return Created; }
        public Catalog setCreated(String value) { this.Created = value; return this; }
        public String getLastUpdated() { return LastUpdated; }
        public Catalog setLastUpdated(String value) { this.LastUpdated = value; return this; }
        public String getName() { return Name; }
        public Catalog setName(String value) { this.Name = value; return this; }
        public String getType() { return Type; }
        public Catalog setType(String value) { this.Type = value; return this; }
        public String getParent() { return Parent; }
        public Catalog setParent(String value) { this.Parent = value; return this; }
        public ArrayList<String> getAncestors() { return Ancestors; }
        public Catalog setAncestors(ArrayList<String> value) { this.Ancestors = value; return this; }
        public HashMap<String,HashMap<String,String>> getItems() { return Items; }
        public Catalog setItems(HashMap<String,HashMap<String,String>> value) { this.Items = value; return this; }
        public Boolean isEnabled() { return Enabled; }
        public Catalog setEnabled(Boolean value) { this.Enabled = value; return this; }
    }

}

Java Catalog DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /{Workspace}/Catalog/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Workspace":"String","AssignedWorkspace":"String","ObjectId":"String","VersionId":"String","BasedOn":"String","ExternalId":"String","Created":"String","LastUpdated":"String","Name":"String","Type":"String","Parent":"String","Ancestors":["String"],"Items":{"String":{"String":"String"}},"Enabled":false}