Field Squared API Services

<back to all web services

Catalog

Contains the data for a catalog within the system.

The following routes are available for this service:
GET,POST,PUT,DELETE/{Workspace}/Catalog/{ObjectId}
GET/{Workspace}/Catalog
Catalog Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
AssignedWorkspacebodystringNo
ObjectIdpathstringNo
VersionIdbodystringNo
BasedOnbodystringNo
ExternalIdbodystringNo
CreatedbodystringNo
LastUpdatedbodystringNo
NamebodystringNo
TypebodystringNo
ParentbodystringNo
AncestorsbodyList<string>No
ItemsbodyDictionary<string, Dictionary<String,String>>No
EnabledbodyboolNo

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"Workspace":"String","AssignedWorkspace":"String","ObjectId":"String","VersionId":"String","BasedOn":"String","ExternalId":"String","Created":"String","LastUpdated":"String","Name":"String","Type":"String","Parent":"String","Ancestors":["String"],"Items":{"String":{"String":"String"}},"Enabled":false}