Field Squared API Services

<back to all web services

ExternalMetadata

Returns standardized metadata for an external connection.

The following routes are available for this service:
GET/{Workspace}/ExternalMetadata/{ConnectionId}

export class MetadataItem
{
    public Name: string;
    public Datatype: string;
    public Length: string;
    public Label: string;

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

export class ExternalObject
{
    public Name: string;
    public Items: MetadataItem[];

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

/** @description Returns standardized metadata for an external connection.  */
export class ExternalMetadata
{
    public Workspace: string;
    public ConnectionId: string;
    public Objects: ExternalObject[];

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

TypeScript ExternalMetadata DTOs

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

HTTP + JSV

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

GET /{Workspace}/ExternalMetadata/{ConnectionId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv