Field Squared API Services

CatalogList

/{Workspace}/CatalogList returns a list of catalogs in the workspace.

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

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 Catalog:
    """
    Contains the data for a catalog within the system.
    """

    workspace: Optional[str] = None
    assigned_workspace: Optional[str] = None
    object_id: Optional[str] = None
    version_id: Optional[str] = None
    based_on: Optional[str] = None
    external_id: Optional[str] = None
    created: Optional[str] = None
    last_updated: Optional[str] = None
    name: Optional[str] = None
    type: Optional[str] = None
    parent: Optional[str] = None
    ancestors: Optional[List[str]] = None
    items: Optional[Dict[str, Dict[str, str]]] = None
    enabled: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CatalogList:
    """
    /{Workspace}/CatalogList returns a list of catalogs in the workspace.
    """

    workspace: Optional[str] = None
    date_generated: Optional[str] = None
    catalogs: Optional[List[Catalog]] = None
    records_available: int = 0

Python CatalogList 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}/CatalogList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv