Field Squared API 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}


export class SeriesSchedule
{
    public Day: number;
    public Start: number;
    public End: number;
    public AllDay: boolean;
    public Duration: number;

    public constructor(init?: Partial<SeriesSchedule>) { (Object as any).assign(this, init); }
}

/** @description Contains the data for a task series object */
export class TaskSeries
{
    public Workspace: string;
    public AssignedWorkspace: string;
    public ObjectId: string;
    public VersionId: string;
    public ExternalId: string;
    public BasedOn: string;
    public Created: string;
    public CreatedBy: string;
    public LastUpdated: string;
    public LastUpdatedLocal: string;
    public TaskName: string;
    public TaskType: string;
    public Users: string[];
    public Teams: string[];
    public SeriesStartDate: string;
    public SeriesEndDate: string;
    public LastTaskEndDate: string;
    public ParentAsset: string;
    public RepeatFrequency: string;
    public RepeatInterval: number;
    public ScheduleDefs: SeriesSchedule[];
    public TemplateId: string;

    public constructor(init?: Partial<TaskSeries>) { (Object as any).assign(this, init); }
}

TypeScript 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>