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}
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Contains the data for a task series template object
*/
open class TaskSeriesTemplate
{
    var Workspace:String? = null
    var AssignedWorkspace:String? = null
    var ObjectId:String? = null
    var VersionId:String? = null
    var ExternalId:String? = null
    var BasedOn:String? = null
    var Created:String? = null
    var CreatedBy:String? = null
    var LastUpdated:String? = null
    var LastUpdatedLocal:String? = null
    var TemplateName:String? = null
    var TaskName:String? = null
    var TaskType:String? = null
    var ParentAsset:String? = null
    var ParentTemplate:String? = null
    var SeriesStartDate:String? = null
    var SeriesEndDate:String? = null
    var DueDate:String? = null
    var CreateFrequency:String? = null
    var RepeatFrequency:String? = null
    var RepeatInterval:Int? = null
    var ScheduleDefs:ArrayList<SeriesSchedule> = ArrayList<SeriesSchedule>()
    var CreateOnAsset:Boolean? = null
    var CreateOnChildren:Boolean? = null
    var BatchCreate:Boolean? = null
    var FutureBatch:Int? = null
    var CreateSchedule:Boolean? = null
    var SetDueDate:Boolean? = null
    var IsRootTemplate:Boolean? = null
    var Users:ArrayList<String> = ArrayList<String>()
    var Teams:ArrayList<String> = ArrayList<String>()
    var Data:String? = null
    var DataTree:HashMap<String,Object> = HashMap<String,Object>()
}

open class SeriesSchedule
{
    var Day:Int? = null
    var Start:Int? = null
    var End:Int? = null
    var AllDay:Boolean? = null
    var Duration:Int? = null
}

Kotlin TaskSeriesTemplate DTOs

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: {}
	}
}