Field Squared API Services

<back to all web services

TaskType

The following routes are available for this service:
GET, POST, DELETE/{Workspace}/TaskType/{Type}
GET/{Workspace}/TaskType
TaskType Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
TypepathstringNo
IconbodystringNo
SkillTagsbodyList<string>No
MinTimeToCompletebodydoubleNo
AvgTimeToCompletebodydoubleNo
MaxTimeToCompletebodydoubleNo
TemplatebodystringNo
DocFilterbodyboolNo
ShowRelatedDocsbodyboolNo
AllowedDocTypesbodyList<string>No
DefaultPrioritybodyint?No
InactivebodyboolNo
AutoCreateDocumentsbodyList<string>No
PercentCompleteTypebodystringNo
UseJobTimersbodyboolNo
InheritAssetTeamsbodyboolNo
InheritContactTeamsbodyboolNo
EditTeamsbodyList<string>No
UseRequiredbodyboolNo
AllowOverridebodyboolNo
RequiredAssetsbodyList<RequiredAsset>No
RequiredInventoryTypesbodyList<RequiredInventoryType>No
RequiredUsersbodyList<RequiredUser>No
ActiveLaborTypesbodyDictionary<string, Object>No
IndividualUserStatusesbodyboolNo
LockOptionbodyboolNo
AutoCreateDocExpressionsbodyList<AutoCreateDocExpression>No
PTObodyboolNo
RequiredAsset Parameters:
NameParameterData TypeRequiredDescription
NumberformintNo
TypeformstringNo
RequiredInventoryType Parameters:
NameParameterData TypeRequiredDescription
NumberformintNo
TypeformstringNo
NameformstringNo
IsSerializedformboolNo
DescriptionformstringNo
RequiredUser Parameters:
NameParameterData TypeRequiredDescription
NumberformintNo
SkillTagsformList<string>No
AutoCreateDocExpression Parameters:
NameParameterData TypeRequiredDescription
DocumentformstringNo
ExpressionformstringNo
MultipleCopiesformboolNo

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}/TaskType/{Type} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	Type: String,
	Icon: String,
	SkillTags: 
	[
		String
	],
	MinTimeToComplete: 0,
	AvgTimeToComplete: 0,
	MaxTimeToComplete: 0,
	Template: String,
	DocFilter: False,
	ShowRelatedDocs: False,
	AllowedDocTypes: 
	[
		String
	],
	DefaultPriority: 0,
	Inactive: False,
	AutoCreateDocuments: 
	[
		String
	],
	PercentCompleteType: String,
	UseJobTimers: False,
	InheritAssetTeams: False,
	InheritContactTeams: False,
	EditTeams: 
	[
		String
	],
	UseRequired: False,
	AllowOverride: False,
	RequiredAssets: 
	[
		{
			Number: 0,
			Type: String
		}
	],
	RequiredInventoryTypes: 
	[
		{
			Number: 0,
			Type: String,
			Name: String,
			IsSerialized: False,
			Description: String
		}
	],
	RequiredUsers: 
	[
		{
			Number: 0,
			SkillTags: 
			[
				String
			]
		}
	],
	ActiveLaborTypes: 
	{
		String: {}
	},
	IndividualUserStatuses: False,
	LockOption: False,
	AutoCreateDocExpressions: 
	[
		{
			Document: String,
			Expression: String,
			MultipleCopies: False
		}
	],
	PTO: False
}