Field Squared API Services

<back to all web services

PublicCatalog

The following routes are available for this service:
GET, PUT, POST, DELETE/{Workspace}/API/Catalog/{CatalogType}
GET, PUT, POST, DELETE/{Workspace}/API/Catalog
GET/{Workspace}/API/Catalog/Schema/{CatalogType}
PublicCatalog Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
CatalogTypepathstringNo
CatalogbodyCatalogNo
CatalogsbodyList<Catalog>No
Catalog Parameters:
NameParameterData TypeRequiredDescription
WorkspaceformstringNo
AssignedWorkspaceformstringNo
ObjectIdformstringNo
VersionIdformstringNo
BasedOnformstringNo
ExternalIdformstringNo
CreatedformstringNo
LastUpdatedformstringNo
NameformstringNo
TypeformstringNo
ParentformstringNo
AncestorsformList<string>No
ItemsformDictionary<string, Dictionary<String,String>>No
EnabledformboolNo

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}/API/Catalog/{CatalogType} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	CatalogType: String,
	Catalog: 
	{
		CatalogType: String,
		LastUpdated: String,
		Created: String,
		Data: 
		{
			String: {}
		}
	},
	Catalogs: 
	[
		{
			CatalogType: String,
			LastUpdated: String,
			Created: String,
			Data: 
			{
				String: {}
			}
		}
	]
}