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}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.Integration;

namespace Field2Office.API.Model.Integration
{
    ///<summary>
    ///Returns standardized metadata for an external connection. 
    ///</summary>
    public partial class ExternalMetadata
    {
        public ExternalMetadata()
        {
            Objects = new List<ExternalObject>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string ConnectionId { get; set; }
        public virtual List<ExternalObject> Objects { get; set; }
    }

    public partial class ExternalObject
    {
        public ExternalObject()
        {
            Items = new List<MetadataItem>{};
        }

        public virtual string Name { get; set; }
        public virtual List<MetadataItem> Items { get; set; }
    }

    public partial class MetadataItem
    {
        public virtual string Name { get; set; }
        public virtual string Datatype { get; set; }
        public virtual string Length { get; set; }
        public virtual string Label { get; set; }
    }

}

C# 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