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}
import Foundation
import ServiceStack

/**
* Contains the data for a task series object
*/
public class TaskSeries : Codable
{
    public var workspace:String
    public var assignedWorkspace:String
    public var objectId:String
    public var versionId:String
    public var externalId:String
    public var basedOn:String
    public var created:String
    public var createdBy:String
    public var lastUpdated:String
    public var lastUpdatedLocal:String
    public var taskName:String
    public var taskType:String
    public var users:[String] = []
    public var teams:[String] = []
    public var seriesStartDate:String
    public var seriesEndDate:String
    public var lastTaskEndDate:String
    public var parentAsset:String
    public var repeatFrequency:String
    public var repeatInterval:Int
    public var scheduleDefs:[SeriesSchedule] = []
    public var templateId:String

    required public init(){}
}

public class SeriesSchedule : Codable
{
    public var day:Int
    public var start:Int
    public var end:Int
    public var allDay:Bool
    public var duration:Int

    required public init(){}
}


Swift TaskSeries 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}/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
}