Field Squared API Services

ExternalMetadata

Returns standardized metadata for an external connection.

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

namespace Field2Office.API.Model.Integration

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type MetadataItem() = 
        member val Name:String = null with get,set
        member val Datatype:String = null with get,set
        member val Length:String = null with get,set
        member val Label:String = null with get,set

    [<AllowNullLiteral>]
    type ExternalObject() = 
        member val Name:String = null with get,set
        member val Items:ResizeArray<MetadataItem> = new ResizeArray<MetadataItem>() with get,set

    ///<summary>
    ///Returns standardized metadata for an external connection. 
    ///</summary>
    [<AllowNullLiteral>]
    type ExternalMetadata() = 
        member val Workspace:String = null with get,set
        member val ConnectionId:String = null with get,set
        member val Objects:ResizeArray<ExternalObject> = new ResizeArray<ExternalObject>() with get,set

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