Field Squared API Services

<back to all web services

AssetList

/{Workspace}/AssetList returns a list of assets in the workspace.
IMPORTANT NOTE: The following 'core field' query parameters can be used to 'contains' filter tasks returned: name, types (comma separated list)
Custom task field 'contains' filters can also be specified by using the binding/key as the query parameter. i.e. Comments=Quick Brown Fox.
Spatial extents can be passed in using: bottomleft=Lat,Lon&topright=Lat,Lon.
To filter on tasks inside a boundary, use boundary=Lat,Lon,Lat,Lon etc.
To filter for assets based on full text search, use fulltext
To filter for assets that can be used as hierarchial nodes use the query parameter syncnodes=true
To filter and return all assets below asset X in the hiearchy, use the query parameter nodeid = X
To filter and return all root level assets, use the query parameter root = true
To filter and return all direct children assets for a given parent, use the query parameter parentid = X
To filter and return all assets modified since a date and time, use the query parameter modifiedsince = X where X = YYYY-MM-DDTHH:MM:SSZ
To filter and return all assets deleted since a date and time, use the query parameter deletedsince = X where X = YYYY-MM-DDTHH:MM:SSZ. Note only Object ID, Workspace and Version is populated.
Multiple sort orders can be specified using a strided list. sorts=value1,value2,value3 where value1 = field name, value2 = ascending/descending, value3 = true/false (true if field is a custom field).
Pagination - /{0}/AssetList?recstart=0&reccount=1.
To suppress geometry from being returned in an effort to improve performance, use the query parameter suppressgeometry=true
/{Workspace}/AssetList/Count returns a count, not the actual object list

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.Assets;
using Field2Office.API.Model;
using Field2Office.API.Model.Schedules;
using Field2Office.Core.Model.Task;

namespace Field2Office.API.Model
{
    public partial class AddressBasic
    {
        public virtual string Street { get; set; }
        public virtual string Unit { get; set; }
        public virtual string City { get; set; }
        public virtual string State { get; set; }
        public virtual string Zip { get; set; }
        public virtual string Country { get; set; }
        public virtual Location Location { get; set; }
    }

    public partial class Anno
    {
        public virtual double X { get; set; }
        public virtual double Y { get; set; }
        public virtual double R { get; set; }
        public virtual double S { get; set; }
        public virtual string T { get; set; }
    }

    ///<summary>
    ///Contains the data for an asset within the system.
    ///</summary>
    public partial class Asset
    {
        public Asset()
        {
            Schedules = new List<Schedule>{};
            Documents = new List<DomainItem>{};
            Tasks = new List<DomainItem>{};
            TaskSeries = new List<string>{};
            TaskSeriesTemplates = new List<string>{};
            Users = new List<DomainItem>{};
            Data = new Dictionary<string, string>{};
            MaintenanceHistory = new List<MaintenanceRecord>{};
            Ancestors = new List<string>{};
            LocationHistory = new List<LocationHistory>{};
            Assets = new List<string>{};
            Contacts = new List<string>{};
            Events = new List<EventItem>{};
            Teams = new List<string>{};
            InventoryItems = new List<string>{};
            ActiveLaborTypes = new Dictionary<string, Object>{};
            CustomDataFields = new List<CustomDataField>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string TimeZone { get; set; }
        public virtual string AssignedWorkspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string VersionId { get; set; }
        public virtual string BasedOn { get; set; }
        public virtual string ExternalId { get; set; }
        public virtual string Created { get; set; }
        public virtual string LastUpdated { get; set; }
        public virtual string Name { get; set; }
        public virtual List<Schedule> Schedules { get; set; }
        public virtual List<DomainItem> Documents { get; set; }
        public virtual List<DomainItem> Tasks { get; set; }
        public virtual List<string> TaskSeries { get; set; }
        public virtual List<string> TaskSeriesTemplates { get; set; }
        public virtual List<DomainItem> Users { get; set; }
        public virtual string Type { get; set; }
        public virtual string Symbol { get; set; }
        public virtual Dictionary<string, string> Data { get; set; }
        public virtual Geometry Geometry { get; set; }
        public virtual List<MaintenanceRecord> MaintenanceHistory { get; set; }
        public virtual string Parent { get; set; }
        public virtual List<string> Ancestors { get; set; }
        public virtual List<LocationHistory> LocationHistory { get; set; }
        public virtual ClassedItem Owner { get; set; }
        public virtual bool IsParent { get; set; }
        public virtual List<string> Assets { get; set; }
        public virtual List<string> Contacts { get; set; }
        public virtual string GeometryString { get; set; }
        public virtual string SourceProjection { get; set; }
        public virtual List<EventItem> Events { get; set; }
        public virtual Anno Anno { get; set; }
        public virtual List<string> Teams { get; set; }
        public virtual AddressBasic Address { get; set; }
        public virtual string CreatedBy { get; set; }
        public virtual List<string> InventoryItems { get; set; }
        public virtual Dictionary<string, Object> ActiveLaborTypes { get; set; }
        public virtual int Levels { get; set; }
        public virtual int AllAssests { get; set; }
        public virtual string Barcode { get; set; }
        public virtual List<CustomDataField> CustomDataFields { get; set; }
    }

    public partial class ClassedItem
    {
        public ClassedItem()
        {
            Ancestors = new List<string>{};
        }

        public virtual string ObjectId { get; set; }
        public virtual string Class { get; set; }
        public virtual string VersionId { get; set; }
        public virtual List<string> Ancestors { get; set; }
        public virtual string Type { get; set; }
    }

    public partial class DomainItem
    {
        public virtual string Workspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string VersionId { get; set; }
        public virtual string LastUpdated { get; set; }
    }

    public partial class EventItem
    {
        public virtual string ObjectId { get; set; }
        public virtual string Date { get; set; }
        public virtual Location Location { get; set; }
        public virtual string Barcode { get; set; }
        public virtual string Details { get; set; }
        public virtual string Type { get; set; }
        public virtual bool IsScan { get; set; }
        public virtual string User { get; set; }
        public virtual string SelectedBy { get; set; }
        public virtual string Status { get; set; }
        public virtual string StatusType { get; set; }
        public virtual string DateCreated { get; set; }
        public virtual bool Automatic { get; set; }
    }

    public partial class Geometry
    {
        public Geometry()
        {
            Coordinates = new List<Location>{};
        }

        public virtual string Type { get; set; }
        public virtual List<Location> Coordinates { get; set; }
    }

    public partial class Location
    {
        public virtual double y { get; set; }
        public virtual double x { get; set; }
    }

    public partial class LocationHistory
    {
        public virtual string Date { get; set; }
        public virtual Location Location { get; set; }
        public virtual string Barcode { get; set; }
        public virtual string Notes { get; set; }
        public virtual bool IsScan { get; set; }
    }

    public partial class MaintenanceRecord
    {
        public virtual string DateTime { get; set; }
        public virtual string Notes { get; set; }
    }

}

namespace Field2Office.API.Model.Assets
{
    ///<summary>
    ////{Workspace}/AssetList returns a list of assets in the workspace.IMPORTANT NOTE: The following 'core field' query parameters can be used to 'contains' filter tasks returned: name, types (comma separated list)Custom task field 'contains' filters can also be specified by using the binding/key as the query parameter. i.e. Comments=Quick Brown Fox. Spatial extents can be passed in using: bottomleft=Lat,Lon&topright=Lat,Lon.  To filter on tasks inside a boundary, use boundary=Lat,Lon,Lat,Lon etc. To filter for assets based on full text search, use fulltext To filter for assets that can be used as hierarchial nodes use the query parameter syncnodes=true To filter and return all assets below asset X in the hiearchy, use the query parameter nodeid = X To filter and return all root level assets, use the query parameter root = true To filter and return all direct children assets for a given parent, use the query parameter parentid = X To filter and return all assets modified since a date and time, use the query parameter modifiedsince = X where X = YYYY-MM-DDTHH:MM:SSZ To filter and return all assets deleted since a date and time, use the query parameter deletedsince = X where X = YYYY-MM-DDTHH:MM:SSZ.  Note only Object ID, Workspace and Version is populated. Multiple sort orders can be specified using a strided list.  sorts=value1,value2,value3 where value1 = field name, value2 = ascending/descending, value3 = true/false (true if field is a custom field). Pagination - /{0}/AssetList?recstart=0&reccount=1. To suppress geometry from being returned in an effort to improve performance, use the query parameter suppressgeometry=true /{Workspace}/AssetList/Count returns a count, not the actual object list
    ///</summary>
    public partial class AssetList
    {
        public AssetList()
        {
            Assets = new List<Asset>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string DateGenerated { get; set; }
        public virtual List<Asset> Assets { get; set; }
        public virtual long RecordsAvailable { get; set; }
    }

}

namespace Field2Office.API.Model.Schedules
{
    public partial class Schedule
    {
        public Schedule()
        {
            Users = new List<string>{};
            Teams = new List<string>{};
            Data = new Dictionary<string, Object>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string VersionId { get; set; }
        public virtual string BasedOn { get; set; }
        public virtual string Start { get; set; }
        public virtual string End { get; set; }
        public virtual string TimeZone { get; set; }
        public virtual List<string> Users { get; set; }
        public virtual List<string> Teams { get; set; }
        public virtual Dictionary<string, Object> Data { get; set; }
    }

}

namespace Field2Office.Core.Model.Task
{
    public partial class CustomDataField
    {
        public virtual string Binding { get; set; }
        public virtual string Label { get; set; }
        public virtual Object Value { get; set; }
        public virtual string DataType { get; set; }
        public virtual bool IsReadOnly { get; set; }
        public virtual bool IsHidden { get; set; }
        public virtual string Values { get; set; }
    }

}

C# AssetList DTOs

GET /{Workspace}/AssetList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv