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

/** @description An object used to capture generic string data and version it */
export class StringData
{
    public Workspace: string;
    public VersionId: string;
    public BasedOn: string;
    public Class: string;
    public Type: string;
    public Data: { [index: string]: Object; };

    public constructor(init?: Partial<StringData>) { (Object as any).assign(this, init); }
}

TypeScript 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
	}
}