Field Squared API Services

Asset

Contains the data for an asset within the system.

The following routes are available for this service:
GET,POST,PUT,DELETE	/{Workspace}/Asset/{ObjectId}
GET	/{Workspace}/Asset

**Asset** Parameters:
Name	Parameter	Data Type	Required
Workspace	path	string	No
TimeZone	body	string	No
AssignedWorkspace	body	string	No
ObjectId	path	string	No
VersionId	body	string	No
BasedOn	body	string	No
ExternalId	body	string	No
Created	body	string	No
LastUpdated	body	string	No
Name	body	string	No
Schedules	body	List<Schedule>	No
Documents	body	List<DomainItem>	No
Tasks	body	List<DomainItem>	No
TaskSeries	body	List<string>	No
TaskSeriesTemplates	body	List<string>	No
Users	body	List<DomainItem>	No
Type	body	string	No
Symbol	body	string	No
Data	body	Dictionary<string, string>	No
Geometry	body	Geometry	No
MaintenanceHistory	body	List<MaintenanceRecord>	No
Parent	body	string	No
Ancestors	body	List<string>	No
LocationHistory	body	List<LocationHistory>	No
Owner	body	ClassedItem	No
IsParent	body	bool	No
Assets	body	List<string>	No
Contacts	body	List<string>	No
GeometryString	body	string	No
SourceProjection	body	string	No
Events	body	List<EventItem>	No
Anno	body	Anno	No
Teams	body	List<string>	No
Address	body	AddressBasic	No
CreatedBy	body	string	No
InventoryItems	body	List<string>	No
ActiveLaborTypes	body	Dictionary<string, Object>	No
Levels	body	int	No
AllAssests	body	int	No
Barcode	body	string	No
CustomDataFields	body	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 .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.

POST /{Workspace}/Asset/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Asset xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
  <ActiveLaborTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </ActiveLaborTypes>
  <Address>
    <City>String</City>
    <Country>String</Country>
    <Location>
      <x>0</x>
      <y>0</y>
    </Location>
    <State>String</State>
    <Street>String</Street>
    <Unit>String</Unit>
    <Zip>String</Zip>
  </Address>
  <AllAssests>0</AllAssests>
  <Ancestors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Ancestors>
  <Anno>
    <R>0</R>
    <S>0</S>
    <T>String</T>
    <X>0</X>
    <Y>0</Y>
  </Anno>
  <Assets xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Assets>
  <AssignedWorkspace>String</AssignedWorkspace>
  <Barcode>String</Barcode>
  <BasedOn>String</BasedOn>
  <Contacts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Contacts>
  <Created>String</Created>
  <CreatedBy>String</CreatedBy>
  <CustomDataFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.Core.Model.Task">
    <d2p1:CustomDataField>
      <d2p1:Binding>String</d2p1:Binding>
      <d2p1:DataType>String</d2p1:DataType>
      <d2p1:IsHidden>false</d2p1:IsHidden>
      <d2p1:IsReadOnly>false</d2p1:IsReadOnly>
      <d2p1:Label>String</d2p1:Label>
      <d2p1:Value />
      <d2p1:Values>String</d2p1:Values>
    </d2p1:CustomDataField>
  </CustomDataFields>
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Data>
  <Documents>
    <DomainItem>
      <LastUpdated>String</LastUpdated>
      <ObjectId>String</ObjectId>
      <VersionId>String</VersionId>
      <Workspace>String</Workspace>
    </DomainItem>
  </Documents>
  <Events>
    <EventItem>
      <Automatic>false</Automatic>
      <Barcode>String</Barcode>
      <Date>String</Date>
      <DateCreated>String</DateCreated>
      <Details>String</Details>
      <IsScan>false</IsScan>
      <Location>
        <x>0</x>
        <y>0</y>
      </Location>
      <ObjectId>String</ObjectId>
      <SelectedBy>String</SelectedBy>
      <Status>String</Status>
      <StatusType>String</StatusType>
      <Type>String</Type>
      <User>String</User>
    </EventItem>
  </Events>
  <ExternalId>String</ExternalId>
  <Geometry>
    <Coordinates>
      <Location>
        <x>0</x>
        <y>0</y>
      </Location>
    </Coordinates>
    <Type>String</Type>
  </Geometry>
  <GeometryString>String</GeometryString>
  <InventoryItems xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InventoryItems>
  <IsParent>false</IsParent>
  <LastUpdated>String</LastUpdated>
  <Levels>0</Levels>
  <LocationHistory>
    <LocationHistory>
      <Barcode>String</Barcode>
      <Date>String</Date>
      <IsScan>false</IsScan>
      <Location>
        <x>0</x>
        <y>0</y>
      </Location>
      <Notes>String</Notes>
    </LocationHistory>
  </LocationHistory>
  <MaintenanceHistory>
    <MaintenanceRecord>
      <DateTime>String</DateTime>
      <Notes>String</Notes>
    </MaintenanceRecord>
  </MaintenanceHistory>
  <Name>String</Name>
  <ObjectId>String</ObjectId>
  <Owner>
    <Ancestors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Ancestors>
    <Class>String</Class>
    <ObjectId>String</ObjectId>
    <Type>String</Type>
    <VersionId>String</VersionId>
  </Owner>
  <Parent>String</Parent>
  <Schedules xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Schedules">
    <d2p1:Schedule>
      <d2p1:BasedOn>String</d2p1:BasedOn>
      <d2p1:Data xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </d2p1:Data>
      <d2p1:End>String</d2p1:End>
      <d2p1:ObjectId>String</d2p1:ObjectId>
      <d2p1:Start>String</d2p1:Start>
      <d2p1:Teams xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Teams>
      <d2p1:TimeZone>String</d2p1:TimeZone>
      <d2p1:Users xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Users>
      <d2p1:VersionId>String</d2p1:VersionId>
      <d2p1:Workspace>String</d2p1:Workspace>
    </d2p1:Schedule>
  </Schedules>
  <SourceProjection>String</SourceProjection>
  <Symbol>String</Symbol>
  <TaskSeries xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TaskSeries>
  <TaskSeriesTemplates xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TaskSeriesTemplates>
  <Tasks>
    <DomainItem>
      <LastUpdated>String</LastUpdated>
      <ObjectId>String</ObjectId>
      <VersionId>String</VersionId>
      <Workspace>String</Workspace>
    </DomainItem>
  </Tasks>
  <Teams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Teams>
  <TimeZone>String</TimeZone>
  <Type>String</Type>
  <Users>
    <DomainItem>
      <LastUpdated>String</LastUpdated>
      <ObjectId>String</ObjectId>
      <VersionId>String</VersionId>
      <Workspace>String</Workspace>
    </DomainItem>
  </Users>
  <VersionId>String</VersionId>
  <Workspace>String</Workspace>
</Asset>