Field Squared API Services

<back to all web services

AssetImport

Bulk import a set of assets..

The following routes are available for this service:
POST/{Workspace}/AssetImport

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); }
}

/** @description Bulk import a set of assets.. */
export class AssetImport
{
    public Workspace: string;
    public Assets: Asset[];
    public RequestId: string;

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

TypeScript AssetImport DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /{Workspace}/AssetImport HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Workspace":"String","Assets":[{"Workspace":"String","TimeZone":"String","AssignedWorkspace":"String","ObjectId":"String","VersionId":"String","BasedOn":"String","ExternalId":"String","Created":"String","LastUpdated":"String","Name":"String","Schedules":[{"Workspace":"String","ObjectId":"String","VersionId":"String","BasedOn":"String","Start":"String","End":"String","TimeZone":"String","Users":["String"],"Teams":["String"],"Data":{"String":{}}}],"Documents":[{"Workspace":"String","ObjectId":"String","VersionId":"String","LastUpdated":"String"}],"Tasks":[{"Workspace":"String","ObjectId":"String","VersionId":"String","LastUpdated":"String"}],"TaskSeries":["String"],"TaskSeriesTemplates":["String"],"Users":[{"Workspace":"String","ObjectId":"String","VersionId":"String","LastUpdated":"String"}],"Type":"String","Symbol":"String","Data":{"String":"String"},"Geometry":{"Type":"String","Coordinates":[{"y":0,"x":0}]},"MaintenanceHistory":[{"DateTime":"String","Notes":"String"}],"Parent":"String","Ancestors":["String"],"LocationHistory":[{"Date":"String","Location":{"y":0,"x":0},"Barcode":"String","Notes":"String","IsScan":false}],"Owner":{"ObjectId":"String","Class":"String","VersionId":"String","Ancestors":["String"],"Type":"String"},"IsParent":false,"Assets":["String"],"Contacts":["String"],"GeometryString":"String","SourceProjection":"String","Events":[{"ObjectId":"String","Date":"String","Location":{"y":0,"x":0},"Barcode":"String","Details":"String","Type":"String","IsScan":false,"User":"String","SelectedBy":"String","Status":"String","StatusType":"String","DateCreated":"String","Automatic":false}],"Anno":{"X":0,"Y":0,"R":0,"S":0,"T":"String"},"Teams":["String"],"Address":{"Street":"String","Unit":"String","City":"String","State":"String","Zip":"String","Country":"String","Location":{"y":0,"x":0}},"CreatedBy":"String","InventoryItems":["String"],"ActiveLaborTypes":{"String":{}},"Levels":0,"AllAssests":0,"Barcode":"String","CustomDataFields":[{"Binding":"String","Label":"String","Value":{},"DataType":"String","IsReadOnly":false,"IsHidden":false,"Values":"String"}]}],"RequestId":"String"}