Field Squared API Services

<back to all web services

PublicAsset

export class Schedule
{
    public Workspace: string;
    public ObjectId: string;
    public VersionId: string;
    public BasedOn: string;
    public Start: string;
    public End: string;
    public TimeZone: string;
    public Users: string[];
    public Teams: string[];
    public Data: { [index: string]: Object; };

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

export class DomainItem
{
    public Workspace: string;
    public ObjectId: string;
    public VersionId: string;
    public LastUpdated: string;

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

export class Location
{
    public y: number;
    public x: number;

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

export class Geometry
{
    public Type: string;
    public Coordinates: Location[];

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

export class MaintenanceRecord
{
    public DateTime: string;
    public Notes: string;

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

export class LocationHistory
{
    public Date: string;
    public Location: Location;
    public Barcode: string;
    public Notes: string;
    public IsScan: boolean;

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

export class ClassedItem
{
    public ObjectId: string;
    public Class: string;
    public VersionId: string;
    public Ancestors: string[];
    public Type: string;

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

export class EventItem
{
    public ObjectId: string;
    public Date: string;
    public Location: Location;
    public Barcode: string;
    public Details: string;
    public Type: string;
    public IsScan: boolean;
    public User: string;
    public SelectedBy: string;
    public Status: string;
    public StatusType: string;
    public DateCreated: string;
    public Automatic: boolean;

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

export class Anno
{
    public X: number;
    public Y: number;
    public R: number;
    public S: number;
    public T: string;

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

export class AddressBasic
{
    public Street: string;
    public Unit: string;
    public City: string;
    public State: string;
    public Zip: string;
    public Country: string;
    public Location: Location;

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

export class CustomDataField
{
    public Binding: string;
    public Label: string;
    public Value: Object;
    public DataType: string;
    public IsReadOnly: boolean;
    public IsHidden: boolean;
    public Values: string;

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

/** @description Contains the data for an asset within the system. */
export class Asset
{
    public Workspace: string;
    public TimeZone: string;
    public AssignedWorkspace: string;
    public ObjectId: string;
    public VersionId: string;
    public BasedOn: string;
    public ExternalId: string;
    public Created: string;
    public LastUpdated: string;
    public Name: string;
    public Schedules: Schedule[];
    public Documents: DomainItem[];
    public Tasks: DomainItem[];
    public TaskSeries: string[];
    public TaskSeriesTemplates: string[];
    public Users: DomainItem[];
    public Type: string;
    public Symbol: string;
    public Data: { [index: string]: string; };
    public Geometry: Geometry;
    public MaintenanceHistory: MaintenanceRecord[];
    public Parent: string;
    public Ancestors: string[];
    public LocationHistory: LocationHistory[];
    public Owner: ClassedItem;
    public IsParent: boolean;
    public Assets: string[];
    public Contacts: string[];
    public GeometryString: string;
    public SourceProjection: string;
    public Events: EventItem[];
    public Anno: Anno;
    public Teams: string[];
    public Address: AddressBasic;
    public CreatedBy: string;
    public InventoryItems: string[];
    public ActiveLaborTypes: { [index: string]: Object; };
    public Levels: number;
    public AllAssests: number;
    public Barcode: string;
    public CustomDataFields: CustomDataField[];

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

// @DataContract
export class PublicAsset
{
    // @DataMember
    public Id: string;

    // @DataMember
    public Workspace: string;

    // @DataMember
    public AssetType: string;

    // @DataMember
    public Asset: Asset;

    // @DataMember
    public Assets: Asset[];

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

TypeScript PublicAsset DTOs

POST /{Workspace}/API/Asset/{Id} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Id":"String","Workspace":"String","AssetType":"String","Asset":{"Name":"String","Type":"String","ExternalId":"String","Parent":"String","Lat":0,"Lon":0,"StreetAddress":"String","Unit":"String","City":"String","State":"String","Zip":"String","Country":"String","Data":{"String":{}},"LastUpdated":"String","Created":"String","Tasks":["String"],"Team":"String"},"Assets":[{"Name":"String","Type":"String","ExternalId":"String","Parent":"String","Lat":0,"Lon":0,"StreetAddress":"String","Unit":"String","City":"String","State":"String","Zip":"String","Country":"String","Data":{"String":{}},"LastUpdated":"String","Created":"String","Tasks":["String"],"Team":"String"}]}