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}
namespace Field2Office.API.Model.Tasks

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SeriesSchedule() = 
        member val Day:Int32 = new Int32() with get,set
        member val Start:Int32 = new Int32() with get,set
        member val End:Int32 = new Int32() with get,set
        member val AllDay:Boolean = new Boolean() with get,set
        member val Duration:Int32 = new Int32() with get,set

    ///<summary>
    ///Contains the data for a task series template object
    ///</summary>
    [<AllowNullLiteral>]
    type TaskSeriesTemplate() = 
        member val Workspace:String = null with get,set
        member val AssignedWorkspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val VersionId:String = null with get,set
        member val ExternalId:String = null with get,set
        member val BasedOn:String = null with get,set
        member val Created:String = null with get,set
        member val CreatedBy:String = null with get,set
        member val LastUpdated:String = null with get,set
        member val LastUpdatedLocal:String = null with get,set
        member val TemplateName:String = null with get,set
        member val TaskName:String = null with get,set
        member val TaskType:String = null with get,set
        member val ParentAsset:String = null with get,set
        member val ParentTemplate:String = null with get,set
        member val SeriesStartDate:String = null with get,set
        member val SeriesEndDate:String = null with get,set
        member val DueDate:String = null with get,set
        member val CreateFrequency:String = null with get,set
        member val RepeatFrequency:String = null with get,set
        member val RepeatInterval:Int32 = new Int32() with get,set
        member val ScheduleDefs:ResizeArray<SeriesSchedule> = new ResizeArray<SeriesSchedule>() with get,set
        member val CreateOnAsset:Boolean = new Boolean() with get,set
        member val CreateOnChildren:Boolean = new Boolean() with get,set
        member val BatchCreate:Boolean = new Boolean() with get,set
        member val FutureBatch:Int32 = new Int32() with get,set
        member val CreateSchedule:Boolean = new Boolean() with get,set
        member val SetDueDate:Boolean = new Boolean() with get,set
        member val IsRootTemplate:Boolean = new Boolean() with get,set
        member val Users:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Teams:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Data:String = null with get,set
        member val DataTree:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set

F# 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":{}}}