Field Squared API Services

<back to all web services

TaskSeries

Contains the data for a task series object

The following routes are available for this service:
GET,PUT,POST,DELETE/{Workspace}/TaskSeries/{ObjectId}
TaskSeries Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
AssignedWorkspacebodystringNo
ObjectIdpathstringNo
VersionIdbodystringNo
ExternalIdbodystringNo
BasedOnbodystringNo
CreatedbodystringNo
CreatedBybodystringNo
LastUpdatedbodystringNo
LastUpdatedLocalbodystringNo
TaskNamebodystringNo
TaskTypebodystringNo
UsersbodyList<string>No
TeamsbodyList<string>No
SeriesStartDatebodystringNo
SeriesEndDatebodystringNo
LastTaskEndDatebodystringNo
ParentAssetbodystringNo
RepeatFrequencybodystringNo
RepeatIntervalbodyintNo
ScheduleDefsbodyList<SeriesSchedule>No
TemplateIdbodystringNo
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}/TaskSeries/{ObjectId} 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,
	TaskName: String,
	TaskType: String,
	Users: 
	[
		String
	],
	Teams: 
	[
		String
	],
	SeriesStartDate: String,
	SeriesEndDate: String,
	LastTaskEndDate: String,
	ParentAsset: String,
	RepeatFrequency: String,
	RepeatInterval: 0,
	ScheduleDefs: 
	[
		{
			Day: 0,
			Start: 0,
			End: 0,
			AllDay: False,
			Duration: 0
		}
	],
	TemplateId: String
}