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
namespace Field2Office.API.Model.Data

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///An object used to capture generic string data and version it
    ///</summary>
    [<AllowNullLiteral>]
    type StringData() = 
        member val Workspace:String = null with get,set
        member val VersionId:String = null with get,set
        member val BasedOn:String = null with get,set
        member val Class:String = null with get,set
        member val Type:String = null with get,set
        member val Data:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set

F# StringData 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.

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

{
	Workspace: String,
	VersionId: String,
	BasedOn: String,
	Class: String,
	Type: String,
	Data: 
	{
		value: String
	}
}