Field Squared API Services

InventoryTree

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


export class InventoryTree
{
    public Workspace: string;
    public IncludeInactive: boolean;
    public OwningAsset: string;
    public OwningTask: string;

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

export class InventoryTreeNode
{
    public Type: string;
    public DescendantCount: number;

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

export class InventoryTreeResponse
{
    public RecordsAvailable: number;
    public Tree: InventoryTreeNode[];

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

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