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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SeriesSchedule:
    day: int = 0
    start: int = 0
    end: int = 0
    all_day: bool = False
    duration: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TaskSeriesTemplate:
    """
    Contains the data for a task series template object
    """

    workspace: Optional[str] = None
    assigned_workspace: Optional[str] = None
    object_id: Optional[str] = None
    version_id: Optional[str] = None
    external_id: Optional[str] = None
    based_on: Optional[str] = None
    created: Optional[str] = None
    created_by: Optional[str] = None
    last_updated: Optional[str] = None
    last_updated_local: Optional[str] = None
    template_name: Optional[str] = None
    task_name: Optional[str] = None
    task_type: Optional[str] = None
    parent_asset: Optional[str] = None
    parent_template: Optional[str] = None
    series_start_date: Optional[str] = None
    series_end_date: Optional[str] = None
    due_date: Optional[str] = None
    create_frequency: Optional[str] = None
    repeat_frequency: Optional[str] = None
    repeat_interval: int = 0
    schedule_defs: Optional[List[SeriesSchedule]] = None
    create_on_asset: bool = False
    create_on_children: bool = False
    batch_create: bool = False
    future_batch: int = 0
    create_schedule: bool = False
    set_due_date: bool = False
    is_root_template: bool = False
    users: Optional[List[str]] = None
    teams: Optional[List[str]] = None
    data: Optional[str] = None
    data_tree: Optional[Dict[str, Object]] = None

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