Field Squared API Services

<back to all web services

Catalog

Contains the data for a catalog within the system.

The following routes are available for this service:
GET,POST,PUT,DELETE/{Workspace}/Catalog/{ObjectId}
GET/{Workspace}/Catalog
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

Python Catalog DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/Catalog/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Workspace":"String","AssignedWorkspace":"String","ObjectId":"String","VersionId":"String","BasedOn":"String","ExternalId":"String","Created":"String","LastUpdated":"String","Name":"String","Type":"String","Parent":"String","Ancestors":["String"],"Items":{"String":{"String":"String"}},"Enabled":false}