Field Squared API Services

<back to all web services

InternalMetadata

Returns a standardized metadata for an internal object.

The following routes are available for this service:
GET/{Workspace}/InternalMetadata/{ObjectType}
GET/{Workspace}/InternalMetadata/{ObjectType}/{SubObjectType}

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); }
}

/** @description Returns a standardized metadata for an internal object.  */
export class InternalMetadata
{
    public Workspace: string;
    public ObjectType: string;
    public SubObjectType: string;
    public Items: MetadataItem[];

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

TypeScript InternalMetadata 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}/InternalMetadata/{ObjectType} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml