Field Squared API Services

PublicTask

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

**PublicTask** Parameters:
Name	Parameter	Data Type	Required
Id	path	string	No
Workspace	path	string	No
TaskTemplate	path	string	No
Task	body	Task	No
Tasks	body	List<Task>	No

**Task** Parameters:
Name	Parameter	Data Type	Required
Workspace	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
LastUpdatedLocal	form	string	No
Rank	form	decimal	No
Name	form	string	No
Description	form	string	No
Address	form	Address	No
Schedules	form	List<Schedule>	No
Status	form	string	No
BlockedReason	form	string	No
TaskType	form	string	No
DueDate	form	string	No
DesiredCompletionDate	form	string	No
DesiredTimeWindow	form	TimeWindow	No
Priority	form	int?	No
PercentComplete	form	double	No
Users	form	List<string>	No
UsersExtended	form	List<DomainItem>	No
Teams	form	List<DomainItem>	No
Documents	form	List<string>	No
Docs	form	List<DomainItem>	No
DocSummaries	form	List<Document>	No
Data	form	Dictionary<string, Object>	No
Contacts	form	List<string>	No
StatusLocation	form	Location	No
Assets	form	List<string>	No
Tasks	form	List<string>	No
Owner	form	string	No
Events	form	List<EventItem>	No
UserStatuses	form	Dictionary<string, List<EventItem>>	No
CreatedBy	form	string	No
TimeZone	form	string	No
SeriesId	form	string	No
JobTimerRunTime	form	int	No
JobTimerPauseTime	form	int	No
JobTimerTransitTime	form	int	No
CurrentJobTimerStatus	form	string	No
CurrentJobTimerTime	form	string	No
InventoryItems	form	List<string>	No
LaborItems	form	List<string>	No
RequiredAssets	form	List<RequiredAsset>	No
RequiredInventoryTypes	form	List<RequiredInventoryType>	No
RequiredUsers	form	List<RequiredUser>	No
Locked	form	bool	No
Ready	form	bool	No
TaskTemplate	form	TaskTemplate	No
CustomDataFields	form	List<CustomDataField>	No

**Address** 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
ContactTitle	form	string	No
ContactName	form	string	No
ContactPhone	form	string	No
ContactEmail	form	string	No
Location	form	Location	No
SiteName	form	string	No
GeocodeFailed	form	bool	No
Country	form	string	No

**Location** Parameters:
Name	Parameter	Data Type	Required	Description
y	form	double	No
x	form	double	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

**TimeWindow** Parameters:
Name	Parameter	Data Type	Required	Description
Start	form	int	No
End	form	int	No

**DomainItem** Parameters:
Name	Parameter	Data Type	Required
Workspace	form	string	No
ObjectId	form	string	No
VersionId	form	string	No
LastUpdated	form	string	No

**Document** Parameters:
Name	Parameter	Data Type	Required
Workspace	form	string	No
AssignedWorkspace	form	string	No
ObjectId	form	string	No
VersionId	form	string	No
BasedOn	form	string	No
Created	form	string	No
ExternalId	form	string	No
LastUpdated	form	string	No
Type	form	string	No
Name	form	string	No
Title	form	string	No
Data	form	Dictionary<string, Object>	No
Owner	form	ClassedItem	No
SecondaryOwners	form	List<ClassedItem>	No
Location	form	Location	No
Date	form	string	No
CreatedBy	form	string	No
PercentComplete	form	double	No
PercentTotal	form	int	No
PercentDone	form	int	No
RangeExceptions	form	List<RangeExceptionItem>	No
Submitted	form	bool	No
Schema	form	string	No
OwnerData	form	DocumentOwnerData	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

**RangeExceptionItem** Parameters:
Name	Parameter	Data Type	Required
Binding	form	string	No
Message	form	string	No
Type	form	string	No
ClassName	form	string	No

**DocumentOwnerData** Parameters:
Name	Parameter	Data Type	Required
OwnerType	form	string	No
TaskData	form	DocumentOwnerDataTask	No
AssetData	form	DocumentOwnerDataAsset	No

**DocumentOwnerDataTask** Parameters:
Name	Parameter	Data Type	Required
ObjectId	form	string	No
Name	form	string	No
Status	form	string	No
TaskType	form	string	No
LastUpdated	form	DateTime	No
Created	form	DateTime	No
Priority	form	int?	No
Rank	form	decimal	No
FirstTeam	form	Team	No
Address	form	Address	No
CustomDataFields	form	List<CustomDataField>	No

**Team** Parameters:
Name	Parameter	Data Type	Required
Workspace	form	string	No
TimeZone	form	string	No
ObjectId	form	string	No
ExternalId	form	string	No
VersionId	form	string	No
BasedOn	form	string	No
Name	form	string	No
Enabled	form	bool	No
Members	form	List<DomainItem>	No
Lead	form	DomainItem	No
Parent	form	DomainItem	No
Address	form	Address	No
Data	form	Dictionary<string, string>	No
Teams	form	List<string>	No
Events	form	List<EventItem>	No
CreatedBy	form	string	No
ActiveLaborTypes	form	Dictionary<string, Object>	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

**Address** Parameters:
Name	Parameter	Data Type	Required
SiteName	form	string	No
ContactTitle	form	string	No
ContactName	form	string	No
ContactPhone	form	string	No
ContactEmail	form	string	No

**AddressBase** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
AddressLine1	form	string	No
AddressLine2	form	string	No
City	form	string	No
State	form	string	No
Zip	form	string	No
Location	form	Location	No
Name	form	string	No
NameSingleLine	form	string	No
NameSingleLine5DigitZip	form	string	No
HasValidLocation	form	bool	No
GeocodeFailed	form	bool	No
GeocodeResultCode	form	string	No
Country	form	string	No

**Location** Parameters:
Name	Parameter	Data Type	Required
Latitude	form	double	No
Longitude	form	double	No
HasValidLocation	form	bool	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

**DocumentOwnerDataAsset** Parameters:
Name	Parameter	Data Type	Required
ObjectId	form	string	No
Name	form	string	No
AssetType	form	string	No
LastUpdated	form	DateTime	No
Created	form	DateTime	No
Address	form	AddressBasic	No
CustomDataFields	form	List<CustomDataField>	No

**RequiredAsset** Parameters:
Name	Parameter	Data Type	Required	Description
Number	form	int	No
Type	form	string	No

**RequiredInventoryType** Parameters:
Name	Parameter	Data Type	Required
Number	form	int	No
Type	form	string	No
Name	form	string	No
IsSerialized	form	bool	No
Description	form	string	No

**RequiredUser** Parameters:
Name	Parameter	Data Type	Required	Description
Number	form	int	No
SkillTags	form	List<string>	No

**TaskTemplate** Parameters:
Name	Parameter	Data Type	Required
CustomFields	form	List<CustomField>	No
Statuses	form	List<TaskStatusDef>	No
TaskListDetails	form	string	No
AutoAssignStatus	form	string	No
AutoUnassignStatus	form	string	No
AutoScheduleStatus	form	string	No
AutoUnscheduleStatus	form	string	No
AutoUpdateStartStatus	form	string	No
AutoUpdateEndStatus	form	string	No
ArrivalStatus	form	string	No
DepartureStatus	form	string	No
ConfirmArrival	form	bool	No
ConfirmDeparture	form	bool	No
ManualArrivalAllowed	form	bool	No
ManualDepartureAllowed	form	bool	No
HideDisabledStatuses	form	bool	No
GeofenceRadius	form	int	No

**CustomField** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
Label	form	string	No
IsActive	form	bool	No
IsReadOnly	form	bool	No
IsHidden	form	bool	No
IsMandatory	form	bool	No
DisplayOnMap	form	bool	No
CustomFieldDataType	form	CustomFieldDataType	No
Values	form	string	No
Prompt	form	string	No
Default	form	string	No
DefaultAutoUpdate	form	bool	No
RequiredIf	form	string	No
Hidden	form	List<string>	No
ReadOnly	form	List<string>	No
ControlArgs	form	Dictionary<string, Object>	No
IndexSlot	form	string	No
Index	form	string	No

**CustomFieldDataType** Enum:
Text
Number
Decimal
Money
PhoneNumber
Ssn
List
Date
File
Barcode
GPS
Photo
Spacer
Separator
AutoNumber
TextArea
Contact
User
Asset
Checkbox
CoreAssetList
CoreTaskList
CoreParentTask
CoreContactList
ComboBox
DateTime
Time
Location
CoreLocation
Label
EventLog
Address
Catalog
CoreTeamList
Segment
CoreTimeSeries
TimeSeries
Command
AutoNumberNumeric
CatalogList
CatalogComboBox
DateRange
DocumentGrid
ReportLink
Hyperlink
PercentComplete
Chart
Range
ExternalId
AssetCatalog
Inventory
CoreTaskLaborItemTypes
CoreTaskLaborItems
ObjectList
CoreTimeZone

**TaskStatusDef** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Color	form	string	No
Code	form	string	No
TransitionFrom	form	string	No
TransitionMessage	form	string	No
TransitionCustomFields	form	List<string>	No
HiddenIf	form	string	No
IsStart	form	bool	No
IsEnd	form	bool	No
IsBlocked	form	bool	No
StatusType	form	string	No
ProgressType	form	string	No
AutoCreateDocuments	form	List<string>	No
LockTask	form	bool	No
SubmittedForms	form	List<BindingDescriptor>	No

**BindingDescriptor** Parameters:
Name	Parameter	Data Type	Required	Description
Binding	form	string	No
Required	form	bool	No

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

HTTP + CSV

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

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

{"Id":"String","Workspace":"String","TaskTemplate":"String","Task":{"Name":"String","Description":"String","ExternalId":"String","TaskType":"String","Priority":0,"DueDate":"String","DesiredCompletionDate":"String","Lat":0,"Lon":0,"StreetAddress":"String","Unit":"String","City":"String","State":"String","Zip":"String","Country":"String","ScheduleStart":"String","ScheduleEnd":"String","Status":"String","User":"String","Team":"String","Asset":"String","Contact":"String","TimeZone":"String","LastUpdated":"String","Created":"String","Data":{"String":{}}},"Tasks":[{"Name":"String","Description":"String","ExternalId":"String","TaskType":"String","Priority":0,"DueDate":"String","DesiredCompletionDate":"String","Lat":0,"Lon":0,"StreetAddress":"String","Unit":"String","City":"String","State":"String","Zip":"String","Country":"String","ScheduleStart":"String","ScheduleEnd":"String","Status":"String","User":"String","Team":"String","Asset":"String","Contact":"String","TimeZone":"String","LastUpdated":"String","Created":"String","Data":{"String":{}}}]}