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

namespace Field2Office.API.Model

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Schedule() = 
        member val Workspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val VersionId:String = null with get,set
        member val BasedOn:String = null with get,set
        member val Start:String = null with get,set
        member val End:String = null with get,set
        member val TimeZone:String = null with get,set
        member val Users:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Teams:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Data:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set

    [<AllowNullLiteral>]
    type DomainItem() = 
        member val Workspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val VersionId:String = null with get,set
        member val LastUpdated:String = null with get,set

    [<AllowNullLiteral>]
    type Location() = 
        member val y:Double = new Double() with get,set
        member val x:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type Geometry() = 
        member val Type:String = null with get,set
        member val Coordinates:ResizeArray<Location> = new ResizeArray<Location>() with get,set

    [<AllowNullLiteral>]
    type MaintenanceRecord() = 
        member val DateTime:String = null with get,set
        member val Notes:String = null with get,set

    [<AllowNullLiteral>]
    type LocationHistory() = 
        member val Date:String = null with get,set
        member val Location:Location = null with get,set
        member val Barcode:String = null with get,set
        member val Notes:String = null with get,set
        member val IsScan:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ClassedItem() = 
        member val ObjectId:String = null with get,set
        member val Class:String = null with get,set
        member val VersionId:String = null with get,set
        member val Ancestors:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Type:String = null with get,set

    [<AllowNullLiteral>]
    type EventItem() = 
        member val ObjectId:String = null with get,set
        member val Date:String = null with get,set
        member val Location:Location = null with get,set
        member val Barcode:String = null with get,set
        member val Details:String = null with get,set
        member val Type:String = null with get,set
        member val IsScan:Boolean = new Boolean() with get,set
        member val User:String = null with get,set
        member val SelectedBy:String = null with get,set
        member val Status:String = null with get,set
        member val StatusType:String = null with get,set
        member val DateCreated:String = null with get,set
        member val Automatic:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type Anno() = 
        member val X:Double = new Double() with get,set
        member val Y:Double = new Double() with get,set
        member val R:Double = new Double() with get,set
        member val S:Double = new Double() with get,set
        member val T:String = null with get,set

    [<AllowNullLiteral>]
    type AddressBasic() = 
        member val Street:String = null with get,set
        member val Unit:String = null with get,set
        member val City:String = null with get,set
        member val State:String = null with get,set
        member val Zip:String = null with get,set
        member val Country:String = null with get,set
        member val Location:Location = null with get,set

    [<AllowNullLiteral>]
    type CustomDataField() = 
        member val Binding:String = null with get,set
        member val Label:String = null with get,set
        member val Value:Object = null with get,set
        member val DataType:String = null with get,set
        member val IsReadOnly:Boolean = new Boolean() with get,set
        member val IsHidden:Boolean = new Boolean() with get,set
        member val Values:String = null with get,set

    ///<summary>
    ///Contains the data for an asset within the system.
    ///</summary>
    [<AllowNullLiteral>]
    type Asset() = 
        member val Workspace:String = null with get,set
        member val TimeZone:String = null with get,set
        member val AssignedWorkspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val VersionId:String = null with get,set
        member val BasedOn:String = null with get,set
        member val ExternalId:String = null with get,set
        member val Created:String = null with get,set
        member val LastUpdated:String = null with get,set
        member val Name:String = null with get,set
        member val Schedules:ResizeArray<Schedule> = new ResizeArray<Schedule>() with get,set
        member val Documents:ResizeArray<DomainItem> = new ResizeArray<DomainItem>() with get,set
        member val Tasks:ResizeArray<DomainItem> = new ResizeArray<DomainItem>() with get,set
        member val TaskSeries:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val TaskSeriesTemplates:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Users:ResizeArray<DomainItem> = new ResizeArray<DomainItem>() with get,set
        member val Type:String = null with get,set
        member val Symbol:String = null with get,set
        member val Data:Dictionary<String, String> = new Dictionary<String, String>() with get,set
        member val Geometry:Geometry = null with get,set
        member val MaintenanceHistory:ResizeArray<MaintenanceRecord> = new ResizeArray<MaintenanceRecord>() with get,set
        member val Parent:String = null with get,set
        member val Ancestors:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val LocationHistory:ResizeArray<LocationHistory> = new ResizeArray<LocationHistory>() with get,set
        member val Owner:ClassedItem = null with get,set
        member val IsParent:Boolean = new Boolean() with get,set
        member val Assets:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Contacts:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val GeometryString:String = null with get,set
        member val SourceProjection:String = null with get,set
        member val Events:ResizeArray<EventItem> = new ResizeArray<EventItem>() with get,set
        member val Anno:Anno = null with get,set
        member val Teams:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Address:AddressBasic = null with get,set
        member val CreatedBy:String = null with get,set
        member val InventoryItems:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val ActiveLaborTypes:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set
        member val Levels:Int32 = new Int32() with get,set
        member val AllAssests:Int32 = new Int32() with get,set
        member val Barcode:String = null with get,set
        member val CustomDataFields:ResizeArray<CustomDataField> = new ResizeArray<CustomDataField>() with get,set

    ///<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>
    [<AllowNullLiteral>]
    type AssetList() = 
        member val Workspace:String = null with get,set
        member val DateGenerated:String = null with get,set
        member val Assets:ResizeArray<Asset> = new ResizeArray<Asset>() with get,set
        member val RecordsAvailable:Int64 = new Int64() with get,set

F# AssetList DTOs

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