Field Squared API Services

ExternalMetadata

Returns standardized metadata for an external connection.

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MetadataItem:
    name: Optional[str] = None
    datatype: Optional[str] = None
    length: Optional[str] = None
    label: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExternalObject:
    name: Optional[str] = None
    items: Optional[List[MetadataItem]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExternalMetadata:
    """
    Returns standardized metadata for an external connection. 
    """

    workspace: Optional[str] = None
    connection_id: Optional[str] = None
    objects: Optional[List[ExternalObject]] = None

Python ExternalMetadata 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}/ExternalMetadata/{ConnectionId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml