Field Squared API Services

ScheduleRequestList

Set schedules for multiple tasks in a single operation.

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Schedule:
    workspace: Optional[str] = None
    object_id: Optional[str] = None
    version_id: Optional[str] = None
    based_on: Optional[str] = None
    start: Optional[str] = None
    end: Optional[str] = None
    time_zone: Optional[str] = None
    users: Optional[List[str]] = None
    teams: Optional[List[str]] = None
    data: Optional[Dict[str, Object]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduleRequest:
    workspace: Optional[str] = None
    object_id: Optional[str] = None
    version_id: Optional[str] = None
    users: Optional[List[str]] = None
    teams: Optional[List[str]] = None
    unassign_users: bool = False
    unassign_teams: bool = False
    unschedule: bool = False
    delete_task: bool = False
    status: Optional[str] = None
    type: Optional[str] = None
    task_type: Optional[str] = None
    due_date: Optional[str] = None
    set_priority: bool = False
    priority: int = 0
    schedules: Optional[List[Schedule]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduleRequestList:
    """
    Set schedules for multiple tasks in a single operation.
    """

    workspace: Optional[str] = None
    schedule_requests: Optional[List[ScheduleRequest]] = None

Python ScheduleRequestList 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}/ScheduleRequestList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ScheduleRequestList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Schedules">
  <ScheduleRequests>
    <ScheduleRequest>
      <DeleteTask>false</DeleteTask>
      <DueDate>String</DueDate>
      <ObjectId>String</ObjectId>
      <Priority>0</Priority>
      <Schedules>
        <Schedule>
          <BasedOn>String</BasedOn>
          <Data xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringanyType>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value />
            </d6p1:KeyValueOfstringanyType>
          </Data>
          <End>String</End>
          <ObjectId>String</ObjectId>
          <Start>String</Start>
          <Teams xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </Teams>
          <TimeZone>String</TimeZone>
          <Users xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </Users>
          <VersionId>String</VersionId>
          <Workspace>String</Workspace>
        </Schedule>
      </Schedules>
      <SetPriority>false</SetPriority>
      <Status>String</Status>
      <TaskType>String</TaskType>
      <Teams xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Teams>
      <Type>String</Type>
      <UnassignTeams>false</UnassignTeams>
      <UnassignUsers>false</UnassignUsers>
      <Unschedule>false</Unschedule>
      <Users xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Users>
      <VersionId>String</VersionId>
      <Workspace>String</Workspace>
    </ScheduleRequest>
  </ScheduleRequests>
  <Workspace>String</Workspace>
</ScheduleRequestList>