Field Squared API Services

<back to all web services

ScheduleRequestList

Set schedules for multiple tasks in a single operation.

The following routes are available for this service:
POST/{Workspace}/ScheduleRequestList

export class Schedule
{
    public Workspace: string;
    public ObjectId: string;
    public VersionId: string;
    public BasedOn: string;
    public Start: string;
    public End: string;
    public TimeZone: string;
    public Users: string[];
    public Teams: string[];
    public Data: { [index: string]: Object; };

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

export class ScheduleRequest
{
    public Workspace: string;
    public ObjectId: string;
    public VersionId: string;
    public Users: string[];
    public Teams: string[];
    public UnassignUsers: boolean;
    public UnassignTeams: boolean;
    public Unschedule: boolean;
    public DeleteTask: boolean;
    public Status: string;
    public Type: string;
    public TaskType: string;
    public DueDate: string;
    public SetPriority: boolean;
    public Priority: number;
    public Schedules: Schedule[];

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

/** @description Set schedules for multiple tasks in a single operation. */
export class ScheduleRequestList
{
    public Workspace: string;
    public ScheduleRequests: ScheduleRequest[];

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

TypeScript ScheduleRequestList DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/ScheduleRequestList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	ScheduleRequests: 
	[
		{
			Workspace: String,
			ObjectId: String,
			VersionId: String,
			Users: 
			[
				String
			],
			Teams: 
			[
				String
			],
			UnassignUsers: False,
			UnassignTeams: False,
			Unschedule: False,
			DeleteTask: False,
			Status: String,
			Type: String,
			TaskType: String,
			DueDate: String,
			SetPriority: False,
			Priority: 0,
			Schedules: 
			[
				{
					Workspace: String,
					ObjectId: String,
					VersionId: String,
					BasedOn: String,
					Start: String,
					End: String,
					TimeZone: String,
					Users: 
					[
						String
					],
					Teams: 
					[
						String
					],
					Data: 
					{
						String: {}
					}
				}
			]
		}
	]
}