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}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Returns standardized metadata for an external connection. 
    */
    public static class ExternalMetadata
    {
        public String Workspace = null;
        public String ConnectionId = null;
        public ArrayList<ExternalObject> Objects = null;
        
        public String getWorkspace() { return Workspace; }
        public ExternalMetadata setWorkspace(String value) { this.Workspace = value; return this; }
        public String getConnectionId() { return ConnectionId; }
        public ExternalMetadata setConnectionId(String value) { this.ConnectionId = value; return this; }
        public ArrayList<ExternalObject> getObjects() { return Objects; }
        public ExternalMetadata setObjects(ArrayList<ExternalObject> value) { this.Objects = value; return this; }
    }

    public static class ExternalObject
    {
        public String Name = null;
        public ArrayList<MetadataItem> Items = null;
        
        public String getName() { return Name; }
        public ExternalObject setName(String value) { this.Name = value; return this; }
        public ArrayList<MetadataItem> getItems() { return Items; }
        public ExternalObject setItems(ArrayList<MetadataItem> value) { this.Items = value; return this; }
    }

    public static class MetadataItem
    {
        public String Name = null;
        public String Datatype = null;
        public String Length = null;
        public String Label = null;
        
        public String getName() { return Name; }
        public MetadataItem setName(String value) { this.Name = value; return this; }
        public String getDatatype() { return Datatype; }
        public MetadataItem setDatatype(String value) { this.Datatype = value; return this; }
        public String getLength() { return Length; }
        public MetadataItem setLength(String value) { this.Length = value; return this; }
        public String getLabel() { return Label; }
        public MetadataItem setLabel(String value) { this.Label = value; return this; }
    }

}

Java 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