Field Squared API Services

<back to all web services

InventoryCategory

The following routes are available for this service:
GET,PUT,POST/{Workspace}/InventoryCategory
GET,PUT,POST/{Workspace}/InventoryCategory/{ObjectId}
InventoryCategory Parameters:
NameParameterData TypeRequiredDescription
TypebodystringNo
ObjectIdpathstringNo
WorkspacepathstringNo
ItemCategorybodystringNo
HideForbodyList<string>No
ShowForbodyList<string>No
ParentCategoryIdbodystringNo
Enabledbodybool?No
ChildNodesbodyList<InventoryTreeNode>No
IncludeInactivebodyboolNo
InventoryTreeNode Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
DescendantCountformintNo

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}/InventoryCategory HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Type":"Category","ObjectId":"String","Workspace":"String","ItemCategory":"String","HideFor":["String"],"ShowFor":["String"],"ParentCategoryId":"String","Enabled":false,"ChildNodes":[{}],"IncludeInactive":false,"DescendantCount":0}