Field Squared API Services

BindingDocumentation

This dto documents a set of controls that match the given workspace and binding.

The following routes are available for this service:
GET	/{Workspace}/apidoc/document/{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); }
}

/** @description This dto documents a set of controls that match the given workspace and binding. */
export class BindingDocumentation
{
    public Workspace: string;
    public Binding: string;
    public Controls: ControlDocumentation[];

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

TypeScript BindingDocumentation DTOs

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

HTTP + XML

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

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