<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:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | path | string | No | |
| DateGenerated | query | string | No | |
| Assets | query | List<Asset> | No | |
| RecordsAvailable | query | long | No | |
Asset Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | form | string | No | |
| TimeZone | form | string | No | |
| AssignedWorkspace | form | string | No | |
| ObjectId | form | string | No | |
| VersionId | form | string | No | |
| BasedOn | form | string | No | |
| ExternalId | form | string | No | |
| Created | form | string | No | |
| LastUpdated | form | string | No | |
| Name | form | string | No | |
| Schedules | form | List<Schedule> | No | |
| Documents | form | List<DomainItem> | No | |
| Tasks | form | List<DomainItem> | No | |
| TaskSeries | form | List<string> | No | |
| TaskSeriesTemplates | form | List<string> | No | |
| Users | form | List<DomainItem> | No | |
| Type | form | string | No | |
| Symbol | form | string | No | |
| Data | form | Dictionary<string, string> | No | |
| Geometry | form | Geometry | No | |
| MaintenanceHistory | form | List<MaintenanceRecord> | No | |
| Parent | form | string | No | |
| Ancestors | form | List<string> | No | |
| LocationHistory | form | List<LocationHistory> | No | |
| Owner | form | ClassedItem | No | |
| IsParent | form | bool | No | |
| Assets | form | List<string> | No | |
| Contacts | form | List<string> | No | |
| GeometryString | form | string | No | |
| SourceProjection | form | string | No | |
| Events | form | List<EventItem> | No | |
| Anno | form | Anno | No | |
| Teams | form | List<string> | No | |
| Address | form | AddressBasic | No | |
| CreatedBy | form | string | No | |
| InventoryItems | form | List<string> | No | |
| ActiveLaborTypes | form | Dictionary<string, Object> | No | |
| Levels | form | int | No | |
| AllAssests | form | int | No | |
| Barcode | form | string | No | |
| CustomDataFields | form | List<CustomDataField> | No | |
Schedule Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | form | string | No | |
| ObjectId | form | string | No | |
| VersionId | form | string | No | |
| BasedOn | form | string | No | |
| Start | form | string | No | |
| End | form | string | No | |
| TimeZone | form | string | No | |
| Users | form | List<string> | No | |
| Teams | form | List<string> | No | |
| Data | form | Dictionary<string, Object> | No | |
DomainItem Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | form | string | No | |
| ObjectId | form | string | No | |
| VersionId | form | string | No | |
| LastUpdated | form | string | No | |
Geometry Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Type | form | string | No | |
| Coordinates | form | List<Location> | No | |
Location Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| y | form | double | No | |
| x | form | double | No | |
MaintenanceRecord Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| DateTime | form | string | No | |
| Notes | form | string | No | |
LocationHistory Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Date | form | string | No | |
| Location | form | Location | No | |
| Barcode | form | string | No | |
| Notes | form | string | No | |
| IsScan | form | bool | No | |
ClassedItem Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ObjectId | form | string | No | |
| Class | form | string | No | |
| VersionId | form | string | No | |
| Ancestors | form | List<string> | No | |
| Type | form | string | No | |
EventItem Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ObjectId | form | string | No | |
| Date | form | string | No | |
| Location | form | Location | No | |
| Barcode | form | string | No | |
| Details | form | string | No | |
| Type | form | string | No | |
| IsScan | form | bool | No | |
| User | form | string | No | |
| SelectedBy | form | string | No | |
| Status | form | string | No | |
| StatusType | form | string | No | |
| DateCreated | form | string | No | |
| Automatic | form | bool | No | |
Anno Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| X | form | double | No | |
| Y | form | double | No | |
| R | form | double | No | |
| S | form | double | No | |
| T | form | string | No | |
AddressBasic Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Street | form | string | No | |
| Unit | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| Zip | form | string | No | |
| Country | form | string | No | |
| Location | form | Location | No | |
CustomDataField Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Binding | form | string | No | |
| Label | form | string | No | |
| Value | form | Object | No | |
| DataType | form | string | No | |
| IsReadOnly | form | bool | No | |
| IsHidden | form | bool | No | |
| Values | form | string | No | |
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