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}


export class ControlDocumentation
{
    public Binding: string;
    public InputFormat: string;
    public InputContraints: string;
    public InputExample: string;

    public constructor(init?: Partial<ControlDocumentation>) { (Object as any).assign(this, init); }
}

export class TemplateDocumentation
{
    public TemplateName: string;
    public TemplateProperties: { [index: string]: string; };
    public Controls: ControlDocumentation[];

    public constructor(init?: Partial<TemplateDocumentation>) { (Object as any).assign(this, init); }
}

/** @description Detail structural compoments and documentation required for a workspace document for a given binding. */
export class WorkspaceFormDocumentation
{
    public Workspace: string;
    public Binding: string;
    public MatchingTemplates: TemplateDocumentation[];

    public constructor(init?: Partial<WorkspaceFormDocumentation>) { (Object as any).assign(this, init); }
}

TypeScript WorkspaceFormDocumentation DTOs

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