Field Squared API Services

WorkspaceFormDocumentation

Detail structural compoments and documentation required for a workspace document for a given binding.

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

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Detail structural compoments and documentation required for a workspace document for a given binding.
    */
    public static class WorkspaceFormDocumentation
    {
        public String Workspace = null;
        public String Binding = null;
        public ArrayList<TemplateDocumentation> MatchingTemplates = null;
        
        public String getWorkspace() { return Workspace; }
        public WorkspaceFormDocumentation setWorkspace(String value) { this.Workspace = value; return this; }
        public String getBinding() { return Binding; }
        public WorkspaceFormDocumentation setBinding(String value) { this.Binding = value; return this; }
        public ArrayList<TemplateDocumentation> getMatchingTemplates() { return MatchingTemplates; }
        public WorkspaceFormDocumentation setMatchingTemplates(ArrayList<TemplateDocumentation> value) { this.MatchingTemplates = value; return this; }
    }

    public static class TemplateDocumentation
    {
        public String TemplateName = null;
        public HashMap<String,String> TemplateProperties = null;
        public ArrayList<ControlDocumentation> Controls = null;
        
        public String getTemplateName() { return TemplateName; }
        public TemplateDocumentation setTemplateName(String value) { this.TemplateName = value; return this; }
        public HashMap<String,String> getTemplateProperties() { return TemplateProperties; }
        public TemplateDocumentation setTemplateProperties(HashMap<String,String> value) { this.TemplateProperties = value; return this; }
        public ArrayList<ControlDocumentation> getControls() { return Controls; }
        public TemplateDocumentation setControls(ArrayList<ControlDocumentation> value) { this.Controls = value; return this; }
    }

    public static class ControlDocumentation
    {
        public String Binding = null;
        public String InputFormat = null;
        public String InputContraints = null;
        public String InputExample = null;
        
        public String getBinding() { return Binding; }
        public ControlDocumentation setBinding(String value) { this.Binding = value; return this; }
        public String getInputFormat() { return InputFormat; }
        public ControlDocumentation setInputFormat(String value) { this.InputFormat = value; return this; }
        public String getInputContraints() { return InputContraints; }
        public ControlDocumentation setInputContraints(String value) { this.InputContraints = value; return this; }
        public String getInputExample() { return InputExample; }
        public ControlDocumentation setInputExample(String value) { this.InputExample = value; return this; }
    }

}

Java WorkspaceFormDocumentation 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.

GET /{Workspace}/apidoc/{Binding} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json