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

/**
* Contains the data for a task series template object
*/
public class TaskSeriesTemplate : 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 templateName:String
    public var taskName:String
    public var taskType:String
    public var parentAsset:String
    public var parentTemplate:String
    public var seriesStartDate:String
    public var seriesEndDate:String
    public var dueDate:String
    public var createFrequency:String
    public var repeatFrequency:String
    public var repeatInterval:Int
    public var scheduleDefs:[SeriesSchedule] = []
    public var createOnAsset:Bool
    public var createOnChildren:Bool
    public var batchCreate:Bool
    public var futureBatch:Int
    public var createSchedule:Bool
    public var setDueDate:Bool
    public var isRootTemplate:Bool
    public var users:[String] = []
    public var teams:[String] = []
    public var data:String
    public var dataTree:[String:Object] = [:]

    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 TaskSeriesTemplate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
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":{}}}