Field Squared API Services

<back to all web services

StringData

An object used to capture generic string data and version it

The following routes are available for this service:
GET,POST,PUT,DELETE/{Workspace}/StringData/{Class}/{Type}
GET/{Workspace}/StringData/{Class}
GET/{Workspace}/StringData/VersionHistory/{Class}/{Type}
GET/{Workspace}/CatalogNames
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 StringData:
    """
    An object used to capture generic string data and version it
    """

    workspace: Optional[str] = None
    version_id: Optional[str] = None
    based_on: Optional[str] = None
    class_: Optional[str] = field(metadata=config(field_name='class'), default=None)
    type: Optional[str] = None
    data: Optional[Dict[str, Object]] = None

Python StringData DTOs

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

HTTP + XML

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

POST /{Workspace}/StringData/{Class}/{Type} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StringData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Data">
  <BasedOn>String</BasedOn>
  <Class>String</Class>
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>value</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string">String</d2p1:Value>
    </d2p1:KeyValueOfstringanyType>
  </Data>
  <Type>String</Type>
  <VersionId>String</VersionId>
  <Workspace>String</Workspace>
  <_data>String</_data>
</StringData>