Field Squared API Services

TaskSeriesTemplate

Contains the data for a task series template object

The following routes are available for this service:
GET,PUT,POST	/{Workspace}/TaskSeriesTemplate
GET,PUT,POST,DELETE	/{Workspace}/TaskSeriesTemplate/{ObjectId}

**TaskSeriesTemplate** Parameters:
Name	Parameter	Data Type	Required
Workspace	path	string	No
AssignedWorkspace	body	string	No
ObjectId	path	string	No
VersionId	body	string	No
ExternalId	body	string	No
BasedOn	body	string	No
Created	body	string	No
CreatedBy	body	string	No
LastUpdated	body	string	No
LastUpdatedLocal	body	string	No
TemplateName	body	string	No
TaskName	body	string	No
TaskType	body	string	No
ParentAsset	body	string	No
ParentTemplate	body	string	No
SeriesStartDate	body	string	No
SeriesEndDate	body	string	No
DueDate	body	string	No
CreateFrequency	body	string	No
RepeatFrequency	body	string	No
RepeatInterval	body	int	No
ScheduleDefs	body	List<SeriesSchedule>	No
CreateOnAsset	body	bool	No
CreateOnChildren	body	bool	No
BatchCreate	body	bool	No
FutureBatch	body	int	No
CreateSchedule	body	bool	No
SetDueDate	body	bool	No
IsRootTemplate	body	bool	No
Users	body	List<string>	No
Teams	body	List<string>	No
Data	body	string	No
DataTree	body	Dictionary<string, Object>	No

**SeriesSchedule** Parameters:
Name	Parameter	Data Type	Required
Day	form	int	No
Start	form	int	No
End	form	int	No
AllDay	form	bool	No
Duration	form	int	No

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

<TaskSeriesTemplate 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>
  <BatchCreate>false</BatchCreate>
  <CreateFrequency>String</CreateFrequency>
  <CreateOnAsset>false</CreateOnAsset>
  <CreateOnChildren>false</CreateOnChildren>
  <CreateSchedule>false</CreateSchedule>
  <Created>String</Created>
  <CreatedBy>String</CreatedBy>
  <Data>String</Data>
  <DataTree xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </DataTree>
  <DueDate>String</DueDate>
  <ExternalId>String</ExternalId>
  <FutureBatch>0</FutureBatch>
  <IsRootTemplate>false</IsRootTemplate>
  <LastUpdated>String</LastUpdated>
  <LastUpdatedLocal>String</LastUpdatedLocal>
  <ObjectId>String</ObjectId>
  <ParentAsset>String</ParentAsset>
  <ParentTemplate>String</ParentTemplate>
  <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>
  <SetDueDate>false</SetDueDate>
  <TaskName>String</TaskName>
  <TaskType>String</TaskType>
  <Teams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Teams>
  <TemplateName>String</TemplateName>
  <Users xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Users>
  <VersionId>String</VersionId>
  <Workspace>String</Workspace>
</TaskSeriesTemplate>