Field Squared API Services

<back to all web services

TaskSeriesTemplate

Contains the data for a task series template object

The following routes are available for this service:
GET,PUT,POST/{Workspace}/TaskSeriesTemplate
GET,PUT,POST,DELETE/{Workspace}/TaskSeriesTemplate/{ObjectId}
TaskSeriesTemplate Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
AssignedWorkspacebodystringNo
ObjectIdpathstringNo
VersionIdbodystringNo
ExternalIdbodystringNo
BasedOnbodystringNo
CreatedbodystringNo
CreatedBybodystringNo
LastUpdatedbodystringNo
LastUpdatedLocalbodystringNo
TemplateNamebodystringNo
TaskNamebodystringNo
TaskTypebodystringNo
ParentAssetbodystringNo
ParentTemplatebodystringNo
SeriesStartDatebodystringNo
SeriesEndDatebodystringNo
DueDatebodystringNo
CreateFrequencybodystringNo
RepeatFrequencybodystringNo
RepeatIntervalbodyintNo
ScheduleDefsbodyList<SeriesSchedule>No
CreateOnAssetbodyboolNo
CreateOnChildrenbodyboolNo
BatchCreatebodyboolNo
FutureBatchbodyintNo
CreateSchedulebodyboolNo
SetDueDatebodyboolNo
IsRootTemplatebodyboolNo
UsersbodyList<string>No
TeamsbodyList<string>No
DatabodystringNo
DataTreebodyDictionary<string, Object>No
SeriesSchedule Parameters:
NameParameterData TypeRequiredDescription
DayformintNo
StartformintNo
EndformintNo
AllDayformboolNo
DurationformintNo

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

{
	Workspace: String,
	AssignedWorkspace: String,
	ObjectId: String,
	VersionId: String,
	ExternalId: String,
	BasedOn: String,
	Created: String,
	CreatedBy: String,
	LastUpdated: String,
	LastUpdatedLocal: String,
	TemplateName: String,
	TaskName: String,
	TaskType: String,
	ParentAsset: String,
	ParentTemplate: String,
	SeriesStartDate: String,
	SeriesEndDate: String,
	DueDate: String,
	CreateFrequency: String,
	RepeatFrequency: String,
	RepeatInterval: 0,
	ScheduleDefs: 
	[
		{
			Day: 0,
			Start: 0,
			End: 0,
			AllDay: False,
			Duration: 0
		}
	],
	CreateOnAsset: False,
	CreateOnChildren: False,
	BatchCreate: False,
	FutureBatch: 0,
	CreateSchedule: False,
	SetDueDate: False,
	IsRootTemplate: False,
	Users: 
	[
		String
	],
	Teams: 
	[
		String
	],
	Data: String,
	DataTree: 
	{
		String: {}
	}
}