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

The following routes are available for this service:
GET/{Workspace}/AssetList
GET/{Workspace}/AssetList/Count
AssetList Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
DateGeneratedquerystringNo
AssetsqueryList<Asset>No
RecordsAvailablequerylongNo
Asset Parameters:
NameParameterData TypeRequiredDescription
WorkspaceformstringNo
TimeZoneformstringNo
AssignedWorkspaceformstringNo
ObjectIdformstringNo
VersionIdformstringNo
BasedOnformstringNo
ExternalIdformstringNo
CreatedformstringNo
LastUpdatedformstringNo
NameformstringNo
SchedulesformList<Schedule>No
DocumentsformList<DomainItem>No
TasksformList<DomainItem>No
TaskSeriesformList<string>No
TaskSeriesTemplatesformList<string>No
UsersformList<DomainItem>No
TypeformstringNo
SymbolformstringNo
DataformDictionary<string, string>No
GeometryformGeometryNo
MaintenanceHistoryformList<MaintenanceRecord>No
ParentformstringNo
AncestorsformList<string>No
LocationHistoryformList<LocationHistory>No
OwnerformClassedItemNo
IsParentformboolNo
AssetsformList<string>No
ContactsformList<string>No
GeometryStringformstringNo
SourceProjectionformstringNo
EventsformList<EventItem>No
AnnoformAnnoNo
TeamsformList<string>No
AddressformAddressBasicNo
CreatedByformstringNo
InventoryItemsformList<string>No
ActiveLaborTypesformDictionary<string, Object>No
LevelsformintNo
AllAssestsformintNo
BarcodeformstringNo
CustomDataFieldsformList<CustomDataField>No
Schedule Parameters:
NameParameterData TypeRequiredDescription
WorkspaceformstringNo
ObjectIdformstringNo
VersionIdformstringNo
BasedOnformstringNo
StartformstringNo
EndformstringNo
TimeZoneformstringNo
UsersformList<string>No
TeamsformList<string>No
DataformDictionary<string, Object>No
DomainItem Parameters:
NameParameterData TypeRequiredDescription
WorkspaceformstringNo
ObjectIdformstringNo
VersionIdformstringNo
LastUpdatedformstringNo
Geometry Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
CoordinatesformList<Location>No
Location Parameters:
NameParameterData TypeRequiredDescription
yformdoubleNo
xformdoubleNo
MaintenanceRecord Parameters:
NameParameterData TypeRequiredDescription
DateTimeformstringNo
NotesformstringNo
LocationHistory Parameters:
NameParameterData TypeRequiredDescription
DateformstringNo
LocationformLocationNo
BarcodeformstringNo
NotesformstringNo
IsScanformboolNo
ClassedItem Parameters:
NameParameterData TypeRequiredDescription
ObjectIdformstringNo
ClassformstringNo
VersionIdformstringNo
AncestorsformList<string>No
TypeformstringNo
EventItem Parameters:
NameParameterData TypeRequiredDescription
ObjectIdformstringNo
DateformstringNo
LocationformLocationNo
BarcodeformstringNo
DetailsformstringNo
TypeformstringNo
IsScanformboolNo
UserformstringNo
SelectedByformstringNo
StatusformstringNo
StatusTypeformstringNo
DateCreatedformstringNo
AutomaticformboolNo
Anno Parameters:
NameParameterData TypeRequiredDescription
XformdoubleNo
YformdoubleNo
RformdoubleNo
SformdoubleNo
TformstringNo
AddressBasic Parameters:
NameParameterData TypeRequiredDescription
StreetformstringNo
UnitformstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
CountryformstringNo
LocationformLocationNo
CustomDataField Parameters:
NameParameterData TypeRequiredDescription
BindingformstringNo
LabelformstringNo
ValueformObjectNo
DataTypeformstringNo
IsReadOnlyformboolNo
IsHiddenformboolNo
ValuesformstringNo

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

HTTP + XML

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: application/xml