Field Squared API Services

<back to all web services

AssetImport

Bulk import a set of assets..

The following routes are available for this service:
POST/{Workspace}/AssetImport
AssetImport Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
AssetsbodyList<Asset>No
RequestIdbodystringNo
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 .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}/AssetImport HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	Assets: 
	[
		{
			Workspace: String,
			TimeZone: String,
			AssignedWorkspace: String,
			ObjectId: String,
			VersionId: String,
			BasedOn: String,
			ExternalId: String,
			Created: String,
			LastUpdated: String,
			Name: String,
			Schedules: 
			[
				{
					Workspace: String,
					ObjectId: String,
					VersionId: String,
					BasedOn: String,
					Start: String,
					End: String,
					TimeZone: String,
					Users: 
					[
						String
					],
					Teams: 
					[
						String
					],
					Data: 
					{
						String: {}
					}
				}
			],
			Documents: 
			[
				{
					Workspace: String,
					ObjectId: String,
					VersionId: String,
					LastUpdated: String
				}
			],
			Tasks: 
			[
				{
					Workspace: String,
					ObjectId: String,
					VersionId: String,
					LastUpdated: String
				}
			],
			TaskSeries: 
			[
				String
			],
			TaskSeriesTemplates: 
			[
				String
			],
			Users: 
			[
				{
					Workspace: String,
					ObjectId: String,
					VersionId: String,
					LastUpdated: String
				}
			],
			Type: String,
			Symbol: String,
			Data: 
			{
				String: String
			},
			Geometry: 
			{
				Type: String,
				Coordinates: 
				[
					{
						y: 0,
						x: 0
					}
				]
			},
			MaintenanceHistory: 
			[
				{
					DateTime: String,
					Notes: String
				}
			],
			Parent: String,
			Ancestors: 
			[
				String
			],
			LocationHistory: 
			[
				{
					Date: String,
					Location: 
					{
						y: 0,
						x: 0
					},
					Barcode: String,
					Notes: String,
					IsScan: False
				}
			],
			Owner: 
			{
				ObjectId: String,
				Class: String,
				VersionId: String,
				Ancestors: 
				[
					String
				],
				Type: String
			},
			IsParent: False,
			Assets: 
			[
				String
			],
			Contacts: 
			[
				String
			],
			GeometryString: String,
			SourceProjection: String,
			Events: 
			[
				{
					ObjectId: String,
					Date: String,
					Location: 
					{
						y: 0,
						x: 0
					},
					Barcode: String,
					Details: String,
					Type: String,
					IsScan: False,
					User: String,
					SelectedBy: String,
					Status: String,
					StatusType: String,
					DateCreated: String,
					Automatic: False
				}
			],
			Anno: 
			{
				X: 0,
				Y: 0,
				R: 0,
				S: 0,
				T: String
			},
			Teams: 
			[
				String
			],
			Address: 
			{
				Street: String,
				Unit: String,
				City: String,
				State: String,
				Zip: String,
				Country: String,
				Location: 
				{
					y: 0,
					x: 0
				}
			},
			CreatedBy: String,
			InventoryItems: 
			[
				String
			],
			ActiveLaborTypes: 
			{
				String: {}
			},
			Levels: 0,
			AllAssests: 0,
			Barcode: String,
			CustomDataFields: 
			[
				{
					Binding: String,
					Label: String,
					Value: {},
					DataType: String,
					IsReadOnly: False,
					IsHidden: False,
					Values: String
				}
			]
		}
	],
	RequestId: String
}