Field Squared API Services

PublicAsset

The following routes are available for this service:
GET	/{Workspace}/API/Asset/Schema
GET, PUT, POST, DELETE	/{Workspace}/API/Asset/{Id}
GET, PUT, POST, DELETE	/{Workspace}/API/Asset
GET	/{Workspace}/API/Asset/Schema/{AssetType}

**PublicAsset** Parameters:
Name	Parameter	Data Type	Required
Id	path	string	No
Workspace	path	string	No
AssetType	path	string	No
Asset	body	Asset	No
Assets	body	List<Asset>	No

**Asset** Parameters:
Name	Parameter	Data Type	Required
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
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
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
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
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
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
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
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
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 .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/API/Asset/{Id} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: String,
	Workspace: String,
	AssetType: String,
	Asset: 
	{
		Name: String,
		Type: String,
		ExternalId: String,
		Parent: String,
		Lat: 0,
		Lon: 0,
		StreetAddress: String,
		Unit: String,
		City: String,
		State: String,
		Zip: String,
		Country: String,
		Data: 
		{
			String: {}
		},
		LastUpdated: String,
		Created: String,
		Tasks: 
		[
			String
		],
		Team: String
	},
	Assets: 
	[
		{
			Name: String,
			Type: String,
			ExternalId: String,
			Parent: String,
			Lat: 0,
			Lon: 0,
			StreetAddress: String,
			Unit: String,
			City: String,
			State: String,
			Zip: String,
			Country: String,
			Data: 
			{
				String: {}
			},
			LastUpdated: String,
			Created: String,
			Tasks: 
			[
				String
			],
			Team: String
		}
	]
}