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

public class dtos
{

    /**
    * Contains the data for a task series object
    */
    public static class TaskSeries
    {
        public String Workspace = null;
        public String AssignedWorkspace = null;
        public String ObjectId = null;
        public String VersionId = null;
        public String ExternalId = null;
        public String BasedOn = null;
        public String Created = null;
        public String CreatedBy = null;
        public String LastUpdated = null;
        public String LastUpdatedLocal = null;
        public String TaskName = null;
        public String TaskType = null;
        public ArrayList<String> Users = null;
        public ArrayList<String> Teams = null;
        public String SeriesStartDate = null;
        public String SeriesEndDate = null;
        public String LastTaskEndDate = null;
        public String ParentAsset = null;
        public String RepeatFrequency = null;
        public Integer RepeatInterval = null;
        public ArrayList<SeriesSchedule> ScheduleDefs = null;
        public String TemplateId = null;
        
        public String getWorkspace() { return Workspace; }
        public TaskSeries setWorkspace(String value) { this.Workspace = value; return this; }
        public String getAssignedWorkspace() { return AssignedWorkspace; }
        public TaskSeries setAssignedWorkspace(String value) { this.AssignedWorkspace = value; return this; }
        public String getObjectId() { return ObjectId; }
        public TaskSeries setObjectId(String value) { this.ObjectId = value; return this; }
        public String getVersionId() { return VersionId; }
        public TaskSeries setVersionId(String value) { this.VersionId = value; return this; }
        public String getExternalId() { return ExternalId; }
        public TaskSeries setExternalId(String value) { this.ExternalId = value; return this; }
        public String getBasedOn() { return BasedOn; }
        public TaskSeries setBasedOn(String value) { this.BasedOn = value; return this; }
        public String getCreated() { return Created; }
        public TaskSeries setCreated(String value) { this.Created = value; return this; }
        public String getCreatedBy() { return CreatedBy; }
        public TaskSeries setCreatedBy(String value) { this.CreatedBy = value; return this; }
        public String getLastUpdated() { return LastUpdated; }
        public TaskSeries setLastUpdated(String value) { this.LastUpdated = value; return this; }
        public String getLastUpdatedLocal() { return LastUpdatedLocal; }
        public TaskSeries setLastUpdatedLocal(String value) { this.LastUpdatedLocal = value; return this; }
        public String getTaskName() { return TaskName; }
        public TaskSeries setTaskName(String value) { this.TaskName = value; return this; }
        public String getTaskType() { return TaskType; }
        public TaskSeries setTaskType(String value) { this.TaskType = value; return this; }
        public ArrayList<String> getUsers() { return Users; }
        public TaskSeries setUsers(ArrayList<String> value) { this.Users = value; return this; }
        public ArrayList<String> getTeams() { return Teams; }
        public TaskSeries setTeams(ArrayList<String> value) { this.Teams = value; return this; }
        public String getSeriesStartDate() { return SeriesStartDate; }
        public TaskSeries setSeriesStartDate(String value) { this.SeriesStartDate = value; return this; }
        public String getSeriesEndDate() { return SeriesEndDate; }
        public TaskSeries setSeriesEndDate(String value) { this.SeriesEndDate = value; return this; }
        public String getLastTaskEndDate() { return LastTaskEndDate; }
        public TaskSeries setLastTaskEndDate(String value) { this.LastTaskEndDate = value; return this; }
        public String getParentAsset() { return ParentAsset; }
        public TaskSeries setParentAsset(String value) { this.ParentAsset = value; return this; }
        public String getRepeatFrequency() { return RepeatFrequency; }
        public TaskSeries setRepeatFrequency(String value) { this.RepeatFrequency = value; return this; }
        public Integer getRepeatInterval() { return RepeatInterval; }
        public TaskSeries setRepeatInterval(Integer value) { this.RepeatInterval = value; return this; }
        public ArrayList<SeriesSchedule> getScheduleDefs() { return ScheduleDefs; }
        public TaskSeries setScheduleDefs(ArrayList<SeriesSchedule> value) { this.ScheduleDefs = value; return this; }
        public String getTemplateId() { return TemplateId; }
        public TaskSeries setTemplateId(String value) { this.TemplateId = value; return this; }
    }

    public static class SeriesSchedule
    {
        public Integer Day = null;
        public Integer Start = null;
        public Integer End = null;
        public Boolean AllDay = null;
        public Integer Duration = null;
        
        public Integer getDay() { return Day; }
        public SeriesSchedule setDay(Integer value) { this.Day = value; return this; }
        public Integer getStart() { return Start; }
        public SeriesSchedule setStart(Integer value) { this.Start = value; return this; }
        public Integer getEnd() { return End; }
        public SeriesSchedule setEnd(Integer value) { this.End = value; return this; }
        public Boolean isAllDay() { return AllDay; }
        public SeriesSchedule setAllDay(Boolean value) { this.AllDay = value; return this; }
        public Integer getDuration() { return Duration; }
        public SeriesSchedule setDuration(Integer value) { this.Duration = value; return this; }
    }

}

Java TaskSeries DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<TaskSeries xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Tasks">
  <AssignedWorkspace>String</AssignedWorkspace>
  <BasedOn>String</BasedOn>
  <Created>String</Created>
  <CreatedBy>String</CreatedBy>
  <ExternalId>String</ExternalId>
  <LastTaskEndDate>String</LastTaskEndDate>
  <LastUpdated>String</LastUpdated>
  <LastUpdatedLocal>String</LastUpdatedLocal>
  <ObjectId>String</ObjectId>
  <ParentAsset>String</ParentAsset>
  <RepeatFrequency>String</RepeatFrequency>
  <RepeatInterval>0</RepeatInterval>
  <ScheduleDefs xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.DomainObjects.Model">
    <d2p1:SeriesSchedule>
      <d2p1:AllDay>false</d2p1:AllDay>
      <d2p1:Day>0</d2p1:Day>
      <d2p1:Duration>0</d2p1:Duration>
      <d2p1:End>0</d2p1:End>
      <d2p1:Start>0</d2p1:Start>
    </d2p1:SeriesSchedule>
  </ScheduleDefs>
  <SeriesEndDate>String</SeriesEndDate>
  <SeriesStartDate>String</SeriesStartDate>
  <TaskName>String</TaskName>
  <TaskType>String</TaskType>
  <Teams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Teams>
  <TemplateId>String</TemplateId>
  <Users xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Users>
  <VersionId>String</VersionId>
  <Workspace>String</Workspace>
</TaskSeries>