<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} | | |
|---|
WorkspaceFormDocumentation Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | path | string | No | |
| Binding | path | string | No | |
| MatchingTemplates | query | List<TemplateDocumentation> | No | |
TemplateDocumentation Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| TemplateName | form | string | No | |
| TemplateProperties | form | Dictionary<string, string> | No | |
| Controls | form | List<ControlDocumentation> | No | |
ControlDocumentation Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Binding | form | string | No | |
| InputFormat | form | string | No | |
| InputContraints | form | string | No | |
| InputExample | form | string | No | |
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.
GET /{Workspace}/apidoc/{Binding} HTTP/1.1
Host: dev.fieldsquared.com
Accept: text/csv