Field Squared API Services

<back to all web services

TaskType

The following routes are available for this service:
GET, POST, DELETE/{Workspace}/TaskType/{Type}
GET/{Workspace}/TaskType
namespace Field2Office.API.Model.Tasks

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type RequiredAsset() = 
        member val Number:Int32 = new Int32() with get,set
        member val Type:String = null with get,set

    [<AllowNullLiteral>]
    type RequiredInventoryType() = 
        member val Number:Int32 = new Int32() with get,set
        member val Type:String = null with get,set
        member val Name:String = null with get,set
        member val IsSerialized:Boolean = new Boolean() with get,set
        member val Description:String = null with get,set

    [<AllowNullLiteral>]
    type RequiredUser() = 
        member val Number:Int32 = new Int32() with get,set
        member val SkillTags:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type AutoCreateDocExpression() = 
        member val Document:String = null with get,set
        member val Expression:String = null with get,set
        member val MultipleCopies:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type TaskType() = 
        member val Workspace:String = null with get,set
        member val Type:String = null with get,set
        member val Icon:String = null with get,set
        member val SkillTags:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val MinTimeToComplete:Double = new Double() with get,set
        member val AvgTimeToComplete:Double = new Double() with get,set
        member val MaxTimeToComplete:Double = new Double() with get,set
        member val Template:String = null with get,set
        member val DocFilter:Boolean = new Boolean() with get,set
        member val ShowRelatedDocs:Boolean = new Boolean() with get,set
        member val AllowedDocTypes:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val DefaultPriority:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Inactive:Boolean = new Boolean() with get,set
        member val AutoCreateDocuments:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val PercentCompleteType:String = null with get,set
        member val UseJobTimers:Boolean = new Boolean() with get,set
        member val InheritAssetTeams:Boolean = new Boolean() with get,set
        member val InheritContactTeams:Boolean = new Boolean() with get,set
        member val EditTeams:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val UseRequired:Boolean = new Boolean() with get,set
        member val AllowOverride:Boolean = new Boolean() with get,set
        member val RequiredAssets:ResizeArray<RequiredAsset> = new ResizeArray<RequiredAsset>() with get,set
        member val RequiredInventoryTypes:ResizeArray<RequiredInventoryType> = new ResizeArray<RequiredInventoryType>() with get,set
        member val RequiredUsers:ResizeArray<RequiredUser> = new ResizeArray<RequiredUser>() with get,set
        member val ActiveLaborTypes:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set
        member val IndividualUserStatuses:Boolean = new Boolean() with get,set
        member val LockOption:Boolean = new Boolean() with get,set
        member val AutoCreateDocExpressions:ResizeArray<AutoCreateDocExpression> = new ResizeArray<AutoCreateDocExpression>() with get,set
        member val PTO:Boolean = new Boolean() with get,set

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

<TaskType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Tasks">
  <ActiveLaborTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </ActiveLaborTypes>
  <AllowOverride>false</AllowOverride>
  <AllowedDocTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AllowedDocTypes>
  <AutoCreateDocExpressions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.DomainObjects.Model">
    <d2p1:AutoCreateDocExpression>
      <d2p1:Document>String</d2p1:Document>
      <d2p1:Expression>String</d2p1:Expression>
      <d2p1:MultipleCopies>false</d2p1:MultipleCopies>
    </d2p1:AutoCreateDocExpression>
  </AutoCreateDocExpressions>
  <AutoCreateDocuments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AutoCreateDocuments>
  <AvgTimeToComplete>0</AvgTimeToComplete>
  <DefaultPriority>0</DefaultPriority>
  <DocFilter>false</DocFilter>
  <EditTeams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EditTeams>
  <Icon>String</Icon>
  <Inactive>false</Inactive>
  <IndividualUserStatuses>false</IndividualUserStatuses>
  <InheritAssetTeams>false</InheritAssetTeams>
  <InheritContactTeams>false</InheritContactTeams>
  <LockOption>false</LockOption>
  <MaxTimeToComplete>0</MaxTimeToComplete>
  <MinTimeToComplete>0</MinTimeToComplete>
  <PTO>false</PTO>
  <PercentCompleteType>String</PercentCompleteType>
  <RequiredAssets xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.DomainObjects.Model">
    <d2p1:RequiredAsset>
      <d2p1:Number>0</d2p1:Number>
      <d2p1:Type>String</d2p1:Type>
    </d2p1:RequiredAsset>
  </RequiredAssets>
  <RequiredInventoryTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.DomainObjects.Model">
    <d2p1:RequiredInventoryType>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:IsSerialized>false</d2p1:IsSerialized>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Number>0</d2p1:Number>
      <d2p1:Type>String</d2p1:Type>
    </d2p1:RequiredInventoryType>
  </RequiredInventoryTypes>
  <RequiredUsers xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.DomainObjects.Model">
    <d2p1:RequiredUser>
      <d2p1:Number>0</d2p1:Number>
      <d2p1:SkillTags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:SkillTags>
    </d2p1:RequiredUser>
  </RequiredUsers>
  <ShowRelatedDocs>false</ShowRelatedDocs>
  <SkillTags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SkillTags>
  <Template>String</Template>
  <Type>String</Type>
  <UseJobTimers>false</UseJobTimers>
  <UseRequired>false</UseRequired>
  <Workspace>String</Workspace>
</TaskType>