Field Squared API Services

InventoryTree

The following routes are available for this service:
GET	/{Workspace}/InventoryTree

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InventoryTree:
    workspace: Optional[str] = None
    include_inactive: bool = False
    owning_asset: Optional[str] = None
    owning_task: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InventoryTreeNode:
    type: Optional[str] = None
    descendant_count: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InventoryTreeResponse:
    records_available: int = 0
    tree: Optional[List[InventoryTreeNode]] = None

Python InventoryTree DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /{Workspace}/InventoryTree HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InventoryTreeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Inventory">
  <RecordsAvailable>0</RecordsAvailable>
  <Tree>
    <InventoryTreeNode i:nil="true" />
  </Tree>
</InventoryTreeResponse>