Field Squared API Services

<back to all web services

PublicCatalog

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 PublicCatalog:
    workspace: Optional[str] = None
    catalog_type: Optional[str] = None
    catalog: Optional[Catalog] = None
    catalogs: Optional[List[Catalog]] = None

Python PublicCatalog DTOs

POST /{Workspace}/API/Catalog/{CatalogType} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	CatalogType: String,
	Catalog: 
	{
		CatalogType: String,
		LastUpdated: String,
		Created: String,
		Data: 
		{
			String: {}
		}
	},
	Catalogs: 
	[
		{
			CatalogType: String,
			LastUpdated: String,
			Created: String,
			Data: 
			{
				String: {}
			}
		}
	]
}