| GET | /{Workspace}/AssetList | ||
|---|---|---|---|
| GET | /{Workspace}/AssetList/Count |
import Foundation
import ServiceStack
/**
* /{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
*/
public class AssetList : Codable
{
public var workspace:String
public var dateGenerated:String
public var assets:[Asset] = []
public var recordsAvailable:Int
required public init(){}
}
/**
* Contains the data for an asset within the system.
*/
public class Asset : Codable
{
public var workspace:String
public var timeZone:String
public var assignedWorkspace:String
public var objectId:String
public var versionId:String
public var basedOn:String
public var externalId:String
public var created:String
public var lastUpdated:String
public var name:String
public var schedules:[Schedule] = []
public var documents:[DomainItem] = []
public var tasks:[DomainItem] = []
public var taskSeries:[String] = []
public var taskSeriesTemplates:[String] = []
public var users:[DomainItem] = []
public var type:String
public var symbol:String
public var data:[String:String] = [:]
public var geometry:Geometry
public var maintenanceHistory:[MaintenanceRecord] = []
public var parent:String
public var ancestors:[String] = []
public var locationHistory:[LocationHistory] = []
public var owner:ClassedItem
public var isParent:Bool
public var assets:[String] = []
public var contacts:[String] = []
public var geometryString:String
public var sourceProjection:String
public var events:[EventItem] = []
public var anno:Anno
public var teams:[String] = []
public var address:AddressBasic
public var createdBy:String
public var inventoryItems:[String] = []
public var activeLaborTypes:[String:Object] = [:]
public var levels:Int
public var allAssests:Int
public var barcode:String
public var customDataFields:[CustomDataField] = []
required public init(){}
}
public class Schedule : Codable
{
public var workspace:String
public var objectId:String
public var versionId:String
public var basedOn:String
public var start:String
public var end:String
public var timeZone:String
public var users:[String] = []
public var teams:[String] = []
public var data:[String:Object] = [:]
required public init(){}
}
public class DomainItem : Codable
{
public var workspace:String
public var objectId:String
public var versionId:String
public var lastUpdated:String
required public init(){}
}
public class Geometry : Codable
{
public var type:String
public var coordinates:[Location] = []
required public init(){}
}
public class Location : Codable
{
public var y:Double
public var x:Double
required public init(){}
}
public class MaintenanceRecord : Codable
{
public var dateTime:String
public var notes:String
required public init(){}
}
public class LocationHistory : Codable
{
public var date:String
public var location:Location
public var barcode:String
public var notes:String
public var isScan:Bool
required public init(){}
}
public class ClassedItem : Codable
{
public var objectId:String
public var `class`:String
public var versionId:String
public var ancestors:[String] = []
public var type:String
required public init(){}
}
public class EventItem : Codable
{
public var objectId:String
public var date:String
public var location:Location
public var barcode:String
public var details:String
public var type:String
public var isScan:Bool
public var user:String
public var selectedBy:String
public var status:String
public var statusType:String
public var dateCreated:String
public var automatic:Bool
required public init(){}
}
public class Anno : Codable
{
public var x:Double
public var y:Double
public var r:Double
public var s:Double
public var t:String
required public init(){}
}
public class AddressBasic : Codable
{
public var street:String
public var unit:String
public var city:String
public var state:String
public var zip:String
public var country:String
public var location:Location
required public init(){}
}
public class CustomDataField : Codable
{
public var binding:String
public var label:String
//value:Object ignored. Type could not be extended in Swift
public var dataType:String
public var isReadOnly:Bool
public var isHidden:Bool
public var values:String
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /{Workspace}/AssetList HTTP/1.1
Host: dev.fieldsquared.com
Accept: text/csv