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}

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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"Workspace":"String","AssignedWorkspace":"String","ObjectId":"String","VersionId":"String","ExternalId":"String","BasedOn":"String","Created":"String","CreatedBy":"String","LastUpdated":"String","LastUpdatedLocal":"String","TaskName":"String","TaskType":"String","Users":["String"],"Teams":["String"],"SeriesStartDate":"String","SeriesEndDate":"String","LastTaskEndDate":"String","ParentAsset":"String","RepeatFrequency":"String","RepeatInterval":0,"ScheduleDefs":[{"Day":0,"Start":0,"End":0,"AllDay":false,"Duration":0}],"TemplateId":"String"}