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
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 RequiredAsset:
    number: int = 0
    type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RequiredInventoryType:
    number: int = 0
    type: Optional[str] = None
    name: Optional[str] = None
    is_serialized: bool = False
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RequiredUser:
    number: int = 0
    skill_tags: Optional[List[str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AutoCreateDocExpression:
    document: Optional[str] = None
    expression: Optional[str] = None
    multiple_copies: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TaskType:
    workspace: Optional[str] = None
    type: Optional[str] = None
    icon: Optional[str] = None
    skill_tags: Optional[List[str]] = None
    min_time_to_complete: float = 0.0
    avg_time_to_complete: float = 0.0
    max_time_to_complete: float = 0.0
    template: Optional[str] = None
    doc_filter: bool = False
    show_related_docs: bool = False
    allowed_doc_types: Optional[List[str]] = None
    default_priority: Optional[int] = None
    inactive: bool = False
    auto_create_documents: Optional[List[str]] = None
    percent_complete_type: Optional[str] = None
    use_job_timers: bool = False
    inherit_asset_teams: bool = False
    inherit_contact_teams: bool = False
    edit_teams: Optional[List[str]] = None
    use_required: bool = False
    allow_override: bool = False
    required_assets: Optional[List[RequiredAsset]] = None
    required_inventory_types: Optional[List[RequiredInventoryType]] = None
    required_users: Optional[List[RequiredUser]] = None
    active_labor_types: Optional[Dict[str, Object]] = None
    individual_user_statuses: bool = False
    lock_option: bool = False
    auto_create_doc_expressions: Optional[List[AutoCreateDocExpression]] = None
    pto: bool = False

Python TaskType DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"Workspace":"String","Type":"String","Icon":"String","SkillTags":["String"],"MinTimeToComplete":0,"AvgTimeToComplete":0,"MaxTimeToComplete":0,"Template":"String","DocFilter":false,"ShowRelatedDocs":false,"AllowedDocTypes":["String"],"DefaultPriority":0,"Inactive":false,"AutoCreateDocuments":["String"],"PercentCompleteType":"String","UseJobTimers":false,"InheritAssetTeams":false,"InheritContactTeams":false,"EditTeams":["String"],"UseRequired":false,"AllowOverride":false,"RequiredAssets":[{"Number":0,"Type":"String"}],"RequiredInventoryTypes":[{"Number":0,"Type":"String","Name":"String","IsSerialized":false,"Description":"String"}],"RequiredUsers":[{"Number":0,"SkillTags":["String"]}],"ActiveLaborTypes":{"String":{}},"IndividualUserStatuses":false,"LockOption":false,"AutoCreateDocExpressions":[{"Document":"String","Expression":"String","MultipleCopies":false}],"PTO":false}