<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} | | |
|---|
TaskSeries Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| 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 | |
| TaskName | body | string | No | |
| TaskType | body | string | No | |
| Users | body | List<string> | No | |
| Teams | body | List<string> | No | |
| SeriesStartDate | body | string | No | |
| SeriesEndDate | body | string | No | |
| LastTaskEndDate | body | string | No | |
| ParentAsset | body | string | No | |
| RepeatFrequency | body | string | No | |
| RepeatInterval | body | int | No | |
| ScheduleDefs | body | List<SeriesSchedule> | No | |
| TemplateId | body | string | No | |
SeriesSchedule Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| 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}/TaskSeries/{ObjectId} HTTP/1.1
Host: dev.fieldsquared.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<TaskSeries 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>
<Created>String</Created>
<CreatedBy>String</CreatedBy>
<ExternalId>String</ExternalId>
<LastTaskEndDate>String</LastTaskEndDate>
<LastUpdated>String</LastUpdated>
<LastUpdatedLocal>String</LastUpdatedLocal>
<ObjectId>String</ObjectId>
<ParentAsset>String</ParentAsset>
<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>
<TaskName>String</TaskName>
<TaskType>String</TaskType>
<Teams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Teams>
<TemplateId>String</TemplateId>
<Users xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Users>
<VersionId>String</VersionId>
<Workspace>String</Workspace>
</TaskSeries>