| 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
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<Catalog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Catalogs">
<Ancestors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Ancestors>
<AssignedWorkspace>String</AssignedWorkspace>
<BasedOn>String</BasedOn>
<Created>String</Created>
<Enabled>false</Enabled>
<ExternalId>String</ExternalId>
<Items xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringArrayOfKeyValueOfstringstringty7Ep6D1>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</d2p1:Value>
</d2p1:KeyValueOfstringArrayOfKeyValueOfstringstringty7Ep6D1>
</Items>
<LastUpdated>String</LastUpdated>
<Name>String</Name>
<ObjectId>String</ObjectId>
<Parent>String</Parent>
<Type>String</Type>
<VersionId>String</VersionId>
<Workspace>String</Workspace>
</Catalog>