Field Squared API Services

<back to all web 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.*


/**
* Detail structural compoments and documentation required for a workspace document for a given binding.
*/
open class WorkspaceFormDocumentation
{
    var Workspace:String? = null
    var Binding:String? = null
    var MatchingTemplates:ArrayList<TemplateDocumentation> = ArrayList<TemplateDocumentation>()
}

open class TemplateDocumentation
{
    var TemplateName:String? = null
    var TemplateProperties:HashMap<String,String> = HashMap<String,String>()
    var Controls:ArrayList<ControlDocumentation> = ArrayList<ControlDocumentation>()
}

open class ControlDocumentation
{
    var Binding:String? = null
    var InputFormat:String? = null
    var InputContraints:String? = null
    var InputExample:String? = null
}

Kotlin 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