| GET | /{Workspace}/API/Task/Schema | ||
|---|---|---|---|
| GET, PUT, POST, DELETE | /{Workspace}/API/Task/{Id} | ||
| GET, PUT, POST, DELETE | /{Workspace}/API/Task | ||
| GET | /{Workspace}/API/Task/Schema/{TaskTemplate} |
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 Location:
latitude: float = 0.0
longitude: float = 0.0
has_valid_location: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddressBase:
id: Optional[str] = None
address_line1: Optional[str] = None
address_line2: Optional[str] = None
city: Optional[str] = None
state: Optional[str] = None
zip: Optional[str] = None
location: Optional[Location] = None
name: Optional[str] = None
name_single_line: Optional[str] = None
name_single_line5_digit_zip: Optional[str] = None
has_valid_location: bool = False
geocode_failed: bool = False
geocode_result_code: Optional[str] = None
country: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Address(AddressBase):
site_name: Optional[str] = None
contact_title: Optional[str] = None
contact_name: Optional[str] = None
contact_phone: Optional[str] = None
contact_email: Optional[str] = None
@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 TimeWindow:
start: int = 0
end: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DomainItem:
workspace: Optional[str] = None
object_id: Optional[str] = None
version_id: Optional[str] = None
last_updated: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClassedItem:
object_id: Optional[str] = None
class_: Optional[str] = field(metadata=config(field_name='class'), default=None)
version_id: Optional[str] = None
ancestors: Optional[List[str]] = None
type: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RangeExceptionItem:
binding: Optional[str] = None
message: Optional[str] = None
type: Optional[str] = None
class_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EventItem:
object_id: Optional[str] = None
date: Optional[str] = None
location: Optional[Location] = None
barcode: Optional[str] = None
details: Optional[str] = None
type: Optional[str] = None
is_scan: bool = False
user: Optional[str] = None
selected_by: Optional[str] = None
status: Optional[str] = None
status_type: Optional[str] = None
date_created: Optional[str] = None
automatic: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Team:
"""
Represents a DTO for a team in a workspace. Calls without an ObjectId will retrieve an array of all team objects for the workspace.
"""
workspace: Optional[str] = None
time_zone: Optional[str] = None
object_id: Optional[str] = None
external_id: Optional[str] = None
version_id: Optional[str] = None
based_on: Optional[str] = None
name: Optional[str] = None
enabled: bool = False
members: Optional[List[DomainItem]] = None
lead: Optional[DomainItem] = None
parent: Optional[DomainItem] = None
address: Optional[Address] = None
data: Optional[Dict[str, str]] = None
teams: Optional[List[str]] = None
events: Optional[List[EventItem]] = None
created_by: Optional[str] = None
active_labor_types: Optional[Dict[str, Object]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomDataField:
binding: Optional[str] = None
label: Optional[str] = None
value: Optional[Object] = None
data_type: Optional[str] = None
is_read_only: bool = False
is_hidden: bool = False
values: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentOwnerDataTask:
object_id: Optional[str] = None
name: Optional[str] = None
status: Optional[str] = None
task_type: Optional[str] = None
last_updated: datetime.datetime = datetime.datetime(1, 1, 1)
created: datetime.datetime = datetime.datetime(1, 1, 1)
priority: Optional[int] = None
rank: Decimal = decimal.Decimal(0)
first_team: Optional[Team] = None
address: Optional[Address] = None
custom_data_fields: Optional[List[CustomDataField]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddressBasic(AddressBase):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentOwnerDataAsset:
object_id: Optional[str] = None
name: Optional[str] = None
asset_type: Optional[str] = None
last_updated: datetime.datetime = datetime.datetime(1, 1, 1)
created: datetime.datetime = datetime.datetime(1, 1, 1)
address: Optional[AddressBasic] = None
custom_data_fields: Optional[List[CustomDataField]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentOwnerData:
owner_type: Optional[str] = None
task_data: Optional[DocumentOwnerDataTask] = None
asset_data: Optional[DocumentOwnerDataAsset] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Document:
"""
Represents a document associated with a task or user. To return multiple documents, call /{Workspace}/Document and pass in query parameter ids = comma separated list of document ids.
"""
workspace: Optional[str] = None
assigned_workspace: Optional[str] = None
object_id: Optional[str] = None
version_id: Optional[str] = None
based_on: Optional[str] = None
created: Optional[str] = None
external_id: Optional[str] = None
last_updated: Optional[str] = None
type: Optional[str] = None
name: Optional[str] = None
title: Optional[str] = None
data: Optional[Dict[str, Object]] = None
owner: Optional[ClassedItem] = None
secondary_owners: Optional[List[ClassedItem]] = None
location: Optional[Location] = None
date: Optional[str] = None
created_by: Optional[str] = None
percent_complete: float = 0.0
percent_total: int = 0
percent_done: int = 0
range_exceptions: Optional[List[RangeExceptionItem]] = None
submitted: bool = False
schema: Optional[str] = None
owner_data: Optional[DocumentOwnerData] = None
@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
class CustomFieldDataType(str, Enum):
TEXT = 'Text'
NUMBER = 'Number'
DECIMAL = 'Decimal'
MONEY = 'Money'
PHONE_NUMBER = 'PhoneNumber'
SSN = 'Ssn'
LIST = 'List'
DATE = 'Date'
FILE = 'File'
BARCODE = 'Barcode'
GPS = 'GPS'
PHOTO = 'Photo'
SPACER = 'Spacer'
SEPARATOR = 'Separator'
AUTO_NUMBER = 'AutoNumber'
TEXT_AREA = 'TextArea'
CONTACT = 'Contact'
USER = 'User'
ASSET = 'Asset'
CHECKBOX = 'Checkbox'
CORE_ASSET_LIST = 'CoreAssetList'
CORE_TASK_LIST = 'CoreTaskList'
CORE_PARENT_TASK = 'CoreParentTask'
CORE_CONTACT_LIST = 'CoreContactList'
COMBO_BOX = 'ComboBox'
DATE_TIME = 'DateTime'
TIME = 'Time'
LOCATION = 'Location'
CORE_LOCATION = 'CoreLocation'
LABEL = 'Label'
EVENT_LOG = 'EventLog'
ADDRESS = 'Address'
CATALOG = 'Catalog'
CORE_TEAM_LIST = 'CoreTeamList'
SEGMENT = 'Segment'
CORE_TIME_SERIES = 'CoreTimeSeries'
TIME_SERIES = 'TimeSeries'
COMMAND = 'Command'
AUTO_NUMBER_NUMERIC = 'AutoNumberNumeric'
CATALOG_LIST = 'CatalogList'
CATALOG_COMBO_BOX = 'CatalogComboBox'
DATE_RANGE = 'DateRange'
DOCUMENT_GRID = 'DocumentGrid'
REPORT_LINK = 'ReportLink'
HYPERLINK = 'Hyperlink'
PERCENT_COMPLETE = 'PercentComplete'
CHART = 'Chart'
RANGE = 'Range'
EXTERNAL_ID = 'ExternalId'
ASSET_CATALOG = 'AssetCatalog'
INVENTORY = 'Inventory'
CORE_TASK_LABOR_ITEM_TYPES = 'CoreTaskLaborItemTypes'
CORE_TASK_LABOR_ITEMS = 'CoreTaskLaborItems'
OBJECT_LIST = 'ObjectList'
CORE_TIME_ZONE = 'CoreTimeZone'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomField:
key: Optional[str] = None
label: Optional[str] = None
is_active: bool = False
is_read_only: bool = False
is_hidden: bool = False
is_mandatory: bool = False
display_on_map: bool = False
custom_field_data_type: Optional[CustomFieldDataType] = None
values: Optional[str] = None
prompt: Optional[str] = None
default: Optional[str] = None
default_auto_update: bool = False
required_if: Optional[str] = None
hidden: Optional[List[str]] = None
read_only: Optional[List[str]] = None
control_args: Optional[Dict[str, Object]] = None
index_slot: Optional[str] = None
index: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BindingDescriptor:
binding: Optional[str] = None
required: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TaskStatusDef:
name: Optional[str] = None
color: Optional[str] = None
code: Optional[str] = None
transition_from: Optional[str] = None
transition_message: Optional[str] = None
transition_custom_fields: Optional[List[str]] = None
hidden_if: Optional[str] = None
is_start: bool = False
is_end: bool = False
is_blocked: bool = False
status_type: Optional[str] = None
progress_type: Optional[str] = None
auto_create_documents: Optional[List[str]] = None
lock_task: bool = False
submitted_forms: Optional[List[BindingDescriptor]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TaskTemplate:
custom_fields: Optional[List[CustomField]] = None
statuses: Optional[List[TaskStatusDef]] = None
task_list_details: Optional[str] = None
auto_assign_status: Optional[str] = None
auto_unassign_status: Optional[str] = None
auto_schedule_status: Optional[str] = None
auto_unschedule_status: Optional[str] = None
auto_update_start_status: Optional[str] = None
auto_update_end_status: Optional[str] = None
arrival_status: Optional[str] = None
departure_status: Optional[str] = None
confirm_arrival: bool = False
confirm_departure: bool = False
manual_arrival_allowed: bool = False
manual_departure_allowed: bool = False
hide_disabled_statuses: bool = False
geofence_radius: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Task:
"""
Contains the data for a task within the system, with versioned object referneces to users and forms.
"""
workspace: Optional[str] = None
assigned_workspace: Optional[str] = None
object_id: Optional[str] = None
version_id: Optional[str] = None
based_on: Optional[str] = None
external_id: Optional[str] = None
created: Optional[str] = None
last_updated: Optional[str] = None
last_updated_local: Optional[str] = None
rank: Decimal = decimal.Decimal(0)
name: Optional[str] = None
description: Optional[str] = None
address: Optional[Address] = None
schedules: Optional[List[Schedule]] = None
status: Optional[str] = None
blocked_reason: Optional[str] = None
task_type: Optional[str] = None
due_date: Optional[str] = None
desired_completion_date: Optional[str] = None
desired_time_window: Optional[TimeWindow] = None
priority: Optional[int] = None
percent_complete: float = 0.0
users: Optional[List[str]] = None
users_extended: Optional[List[DomainItem]] = None
teams: Optional[List[DomainItem]] = None
documents: Optional[List[str]] = None
docs: Optional[List[DomainItem]] = None
doc_summaries: Optional[List[Document]] = None
data: Optional[Dict[str, Object]] = None
contacts: Optional[List[str]] = None
status_location: Optional[Location] = None
assets: Optional[List[str]] = None
tasks: Optional[List[str]] = None
owner: Optional[str] = None
events: Optional[List[EventItem]] = None
user_statuses: Optional[Dict[str, List[EventItem]]] = None
created_by: Optional[str] = None
time_zone: Optional[str] = None
series_id: Optional[str] = None
job_timer_run_time: int = 0
job_timer_pause_time: int = 0
job_timer_transit_time: int = 0
current_job_timer_status: Optional[str] = None
current_job_timer_time: Optional[str] = None
inventory_items: Optional[List[str]] = None
labor_items: Optional[List[str]] = None
required_assets: Optional[List[RequiredAsset]] = None
required_inventory_types: Optional[List[RequiredInventoryType]] = None
required_users: Optional[List[RequiredUser]] = None
locked: bool = False
ready: bool = False
task_template: Optional[TaskTemplate] = None
custom_data_fields: Optional[List[CustomDataField]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PublicTask:
id: Optional[str] = None
workspace: Optional[str] = None
task_template: Optional[str] = None
task: Optional[Task] = None
tasks: Optional[List[Task]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Address:
street: Optional[str] = None
unit: Optional[str] = None
city: Optional[str] = None
state: Optional[str] = None
zip: Optional[str] = None
contact_title: Optional[str] = None
contact_name: Optional[str] = None
contact_phone: Optional[str] = None
contact_email: Optional[str] = None
location: Optional[Location] = None
site_name: Optional[str] = None
geocode_failed: bool = False
country: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Location:
y: float = 0.0
x: float = 0.0
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /{Workspace}/API/Task/{Id} HTTP/1.1
Host: dev.fieldsquared.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Id":"String","Workspace":"String","TaskTemplate":"String","Task":{"Name":"String","Description":"String","ExternalId":"String","TaskType":"String","Priority":0,"DueDate":"String","DesiredCompletionDate":"String","Lat":0,"Lon":0,"StreetAddress":"String","Unit":"String","City":"String","State":"String","Zip":"String","Country":"String","ScheduleStart":"String","ScheduleEnd":"String","Status":"String","User":"String","Team":"String","Asset":"String","Contact":"String","TimeZone":"String","LastUpdated":"String","Created":"String","Data":{"String":{}}},"Tasks":[{"Name":"String","Description":"String","ExternalId":"String","TaskType":"String","Priority":0,"DueDate":"String","DesiredCompletionDate":"String","Lat":0,"Lon":0,"StreetAddress":"String","Unit":"String","City":"String","State":"String","Zip":"String","Country":"String","ScheduleStart":"String","ScheduleEnd":"String","Status":"String","User":"String","Team":"String","Asset":"String","Contact":"String","TimeZone":"String","LastUpdated":"String","Created":"String","Data":{"String":{}}}]}