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
ScheduleRequestList Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
ScheduleRequestsbodyList<ScheduleRequest>No
ScheduleRequest Parameters:
NameParameterData TypeRequiredDescription
WorkspaceformstringNo
ObjectIdformstringNo
VersionIdformstringNo
UsersformList<string>No
TeamsformList<string>No
UnassignUsersformboolNo
UnassignTeamsformboolNo
UnscheduleformboolNo
DeleteTaskformboolNo
StatusformstringNo
TypeformstringNo
TaskTypeformstringNo
DueDateformstringNo
SetPriorityformboolNo
PriorityformintNo
SchedulesformList<Schedule>No
Schedule Parameters:
NameParameterData TypeRequiredDescription
WorkspaceformstringNo
ObjectIdformstringNo
VersionIdformstringNo
BasedOnformstringNo
StartformstringNo
EndformstringNo
TimeZoneformstringNo
UsersformList<string>No
TeamsformList<string>No
DataformDictionary<string, Object>No

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: {}
					}
				}
			]
		}
	]
}