Field Squared API 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}

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 InternalMetadata:
    """
    Returns a standardized metadata for an internal object. 
    """

    workspace: Optional[str] = None
    object_type: Optional[str] = None
    sub_object_type: Optional[str] = None
    items: Optional[List[MetadataItem]] = None

Python InternalMetadata DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv