| GET,POST | /{ObjectId}/Workspace | ||
|---|---|---|---|
| POST | /workspace |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ObjectId | path | string | No | |
| VersionId | body | string | No | |
| BasedOn | body | string | No | |
| Name | body | string | No | |
| LastUpdated | body | DateTime | No | |
| PaymentRequired | body | bool | No | |
| CompanyName | body | string | No | |
| CompanyLogoUri | body | string | No | |
| CompanySupportUrl | body | string | No | |
| CompanySupportEmail | body | string | No | |
| AdminEmail | body | string | No | |
| CompanyAddress | body | Address | No | |
| TaskTitle | body | string | No | |
| TasksTitle | body | string | No | |
| TeamTitle | body | string | No | |
| TeamsTitle | body | string | No | |
| UserTitle | body | string | No | |
| UsersTitle | body | string | No | |
| ContactTitle | body | string | No | |
| ContactsTitle | body | string | No | |
| SalesforceElementId | body | string | No | |
| ScheduleTitle | body | string | No | |
| SchedulesTitle | body | string | No | |
| FormTitle | body | string | No | |
| FormsTitle | body | string | No | |
| PoiTitle | body | string | No | |
| PoisTitle | body | string | No | |
| AssetMakeTitle | body | string | No | |
| AssetModelTitle | body | string | No | |
| AssetManufacturerTitle | body | string | No | |
| AssetBarcodeTitle | body | string | No | |
| AssetAncestorsTitle | body | string | No | |
| AssetWarehouseTitle | body | string | No | |
| AssetWarehousesTitle | body | string | No | |
| AssetVehicleTitle | body | string | No | |
| AssetVehiclesTitle | body | string | No | |
| UseTeamMaps | body | bool | No | |
| UseContacts | body | bool | No | |
| UseAssets | body | bool | No | |
| ShouldRunIntegrations | body | bool | No | |
| TaskTemplates | body | Dictionary<string, TaskTemplate> | No | |
| FormTemplates | body | string | No | |
| DocTemplateGhosts | body | Dictionary<string, DocumentTemplateGhost> | No | |
| AssetTypes | body | Dictionary<string, AssetType> | No | |
| CatalogTypes | body | List<CatalogType> | No | |
| TaskTypes | body | List<TaskType> | No | |
| WorkWeek | body | List<WorkDay> | No | |
| SalesTaxRate | body | double | No | |
| SkillTags | body | List<string> | No | |
| TimeZoneId | body | string | No | |
| IANATimeZoneId | body | string | No | |
| Country | body | string | No | |
| StopTime | body | int | No | |
| StopDistance | body | int | No | |
| SpeedingSpeed | body | double | No | |
| SpeedingDuration | body | int | No | |
| ContactIcon | body | string | No | |
| UseOnSiteContact | body | bool | No | |
| UseServiceAddresses | body | bool | No | |
| UseSharedWorkspaces | body | bool | No | |
| IsMetric | body | bool | No | |
| BreakLength | body | List<int> | No | |
| PriorityNames | body | List<string> | No | |
| PriorityDefault | body | string | No | |
| IsFinanceIntegrationEnabled | body | bool | No | |
| IsCRMIntegrationEnabled | body | bool | No | |
| IsBoxIntegrationEnabled | body | bool | No | |
| IsDropboxIntegrationEnabled | body | bool | No | |
| IsGoogleDriveIntegrationEnabled | body | bool | No | |
| IsEsriIntegrationEnabled | body | bool | No | |
| IsPaycomIntegrationEnabled | body | bool | No | |
| IsP21IntegrationEnabled | body | bool | No | |
| Images | body | List<WorkspaceImage> | No | |
| ContactCustomFields | body | List<CustomField> | No | |
| UserCustomFields | body | List<CustomField> | No | |
| TeamCustomFields | body | List<CustomField> | No | |
| UseAssetMaintenanceHistory | body | bool | No | |
| UseAssetSchedules | body | bool | No | |
| UseTaskAssets | body | bool | No | |
| UseSchedules | body | bool | No | |
| UseTasks | body | bool | No | |
| AssetsReadOnly | body | bool | No | |
| AssetVisibilityMax | body | double | No | |
| ContactVisibilityMax | body | double | No | |
| TaskVisibilityMax | body | double | No | |
| AutoScanAndTrackAsset | body | bool | No | |
| BarcodeTrackAsset | body | bool | No | |
| GPSTrackAsset | body | bool | No | |
| CustomReports | body | List<CustomReport> | No | |
| ShowRelatedContactDocs | body | bool | No | |
| ShowRelatedAssetDocs | body | bool | No | |
| RequireAssetName | body | bool | No | |
| ShowRelatedTaskDocs | body | bool | No | |
| ClientBacklogSort | body | List<ClientBacklogSortItem> | No | |
| AutoAssignJobOnDriving | body | bool | No | |
| AutoAssignJobOnSite | body | bool | No | |
| AutoAssignJobOnComplete | body | bool | No | |
| AutoUnassignJobOnNotStarted | body | bool | No | |
| AutoScheduleJobOnDriving | body | bool | No | |
| AutoScheduleJobOnComplete | body | bool | No | |
| AutoScheduleJobOnSite | body | bool | No | |
| AutoUnscheduleJobOnNotStarted | body | bool | No | |
| AutoUpdateJobStartTimeOnSite | body | bool | No | |
| AutoUpdateJobEndTimeOnComplete | body | bool | No | |
| AutoAssignNewTasksTo | body | string | No | |
| UseIntegrationEmail | body | bool | No | |
| UseTaskTarget | body | bool | No | |
| UseTaskDue | body | bool | No | |
| UseTaskPri | body | bool | No | |
| UseTaskAddr | body | bool | No | |
| TaskListDetails | body | string | No | |
| AutocreateTaskStatusEvents | body | bool | No | |
| AutocreateTaskAssignmentEvents | body | bool | No | |
| FilterContactsByTeam | body | bool | No | |
| FilterUsersAndTeamsByTeam | body | bool | No | |
| AutoUpdateTaskContactChanged | body | bool | No | |
| AutoAssignTeamsOnTaskCreate | body | bool | No | |
| HtmlEmailIncludeTaskName | body | bool | No | |
| HtmlEmailIncludeUsers | body | bool | No | |
| HtmlEmailIncludeDateCreated | body | bool | No | |
| HtmlEmailIncludeDateLastUpdated | body | bool | No | |
| ClientStartupView | body | string | No | |
| ClientAutoSyncInterval | body | int | No | |
| MobileTaskRangePast | body | int | No | |
| MobileTaskRangeFuture | body | int | No | |
| ClientShowScheduledTasks | body | bool | No | |
| ClientShowMyTasksOnly | body | bool | No | |
| ClientShowBacklogTasks | body | bool | No | |
| ClientHideCompleteTasks | body | bool | No | |
| ClientMapType | body | string | No | |
| ClientGPSAccuracy | body | string | No | |
| ClientShowTaskIconsOnMap | body | bool | No | |
| ClientMapLayerScheduledTasks | body | bool | No | |
| ClientMapLayerBacklog | body | bool | No | |
| ClientMapLayerAssets | body | bool | No | |
| ClientMapLayerContacts | body | bool | No | |
| ClientMapLayerTracks | body | bool | No | |
| ClientMapLayerStops | body | bool | No | |
| ClientMapLayerSpeeding | body | bool | No | |
| ClientMapStartLocation | body | string | No | |
| SecurityDict | body | Dictionary<string, int> | No | |
| ContactSearchResultExpression | body | string | No | |
| LandscapePhotos | body | bool | No | |
| LogApiTraffic | body | bool | No | |
| UseDueDate | body | bool | No | |
| UsePriority | body | bool | No | |
| ScheduleTimeZones | body | List<string> | No | |
| UseTimezones | body | bool | No | |
| TaskListSummaryExpression1 | body | string | No | |
| TaskListSummaryExpression2 | body | string | No | |
| ShowScheduleButton | body | bool | No | |
| ShowScheduleGrid | body | bool | No | |
| ScheduleCustomFields | body | List<CustomField> | No | |
| ScheduleGridConfig | body | ScheduleGridConfiguration | No | |
| SaveOnPhoto | body | bool | No | |
| CleanseGeocodes | body | bool | No | |
| GeocodeQuality | body | string | No | |
| RetainCustomerDatabase | body | string | No | |
| RetainAssetDatabase | body | string | No | |
| ShowDriveTimes | body | bool | No | |
| LocAccFilter | body | double | No | |
| AutoCreateRoutesFromAssignedTasks | body | bool | No | |
| TaskNameExpression | body | string | No | |
| UseAddressCountry | body | bool | No | |
| MessageAppEnabled | body | bool | No | |
| GisLayers | body | List<string> | No | |
| AllowStatusDoubleClick | body | bool | No | |
| UseTimecard | body | bool | No | |
| TimecardCategories | body | List<string> | No | |
| UseLocalAdminUsers | body | bool | No | |
| UseInventory | body | bool | No | |
| ClientScheduledTaskSort | body | int | No | |
| LaborPricingHierarchy | body | List<string> | No | |
| UseLabor | body | bool | No | |
| LaborHourFormat | body | bool | No | |
| TfaEnabled | body | bool | No | |
| TaskNameExpressionAutoUpdate | body | bool | No | |
| AutocreateInitialTaskStatusEvent | body | bool | No | |
| InactivityTimer | body | int? | No | |
| OfflineAuthTimer | body | int? | No | |
| Sequences | body | Dictionary<string, int> | No | |
| OverrideEmail | body | string | No | |
| OverrideSms | body | string | No | |
| PortalImageUrl | body | string | No | |
| PortalImageId | body | string | No | |
| SecureImageService | body | bool | No | |
| SuppressAssetTeamCascading | body | bool | No | |
| MilitaryTime | body | bool | No | |
| SecureHookService | body | bool | No | |
| ShowDashboard | body | bool | No | |
| DefaultBusinessHours | body | bool | No | |
| ForceSso | body | Dictionary<string, bool> | No | |
| SuppressSsoAccountCreation | body | bool? | No | |
| UseAdvancedScheduler | body | bool? | No | |
| EnableUnsavedChangesPrompt | body | bool | No | |
| ReturnInactiveWorkspace | body | bool | No | |
| CustomerSupportEmail | body | string | No | |
| CustomerSupportPhoneNumber | body | string | No | |
| ShowColorCode | body | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Street | form | string | No | |
| Unit | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| Zip | form | string | No | |
| ContactTitle | form | string | No | |
| ContactName | form | string | No | |
| ContactPhone | form | string | No | |
| ContactEmail | form | string | No | |
| Location | form | Location | No | |
| SiteName | form | string | No | |
| GeocodeFailed | form | bool | No | |
| Country | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| y | form | double | No | |
| x | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomFields | form | List<CustomField> | No | |
| Statuses | form | List<TaskStatusDef> | No | |
| TaskListDetails | form | string | No | |
| AutoAssignStatus | form | string | No | |
| AutoUnassignStatus | form | string | No | |
| AutoScheduleStatus | form | string | No | |
| AutoUnscheduleStatus | form | string | No | |
| AutoUpdateStartStatus | form | string | No | |
| AutoUpdateEndStatus | form | string | No | |
| ArrivalStatus | form | string | No | |
| DepartureStatus | form | string | No | |
| ConfirmArrival | form | bool | No | |
| ConfirmDeparture | form | bool | No | |
| ManualArrivalAllowed | form | bool | No | |
| ManualDepartureAllowed | form | bool | No | |
| HideDisabledStatuses | form | bool | No | |
| GeofenceRadius | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | form | string | No | |
| Label | form | string | No | |
| IsActive | form | bool | No | |
| IsReadOnly | form | bool | No | |
| IsHidden | form | bool | No | |
| IsMandatory | form | bool | No | |
| DisplayOnMap | form | bool | No | |
| CustomFieldDataType | form | CustomFieldDataType | No | |
| Values | form | string | No | |
| Prompt | form | string | No | |
| Default | form | string | No | |
| DefaultAutoUpdate | form | bool | No | |
| RequiredIf | form | string | No | |
| Hidden | form | List<string> | No | |
| ReadOnly | form | List<string> | No | |
| ControlArgs | form | Dictionary<string, Object> | No | |
| IndexSlot | form | string | No | |
| Index | form | string | No |
| Text | |
| Number | |
| Decimal | |
| Money | |
| PhoneNumber | |
| Ssn | |
| List | |
| Date | |
| File | |
| Barcode | |
| GPS | |
| Photo | |
| Spacer | |
| Separator | |
| AutoNumber | |
| TextArea | |
| Contact | |
| User | |
| Asset | |
| Checkbox | |
| CoreAssetList | |
| CoreTaskList | |
| CoreParentTask | |
| CoreContactList | |
| ComboBox | |
| DateTime | |
| Time | |
| Location | |
| CoreLocation | |
| Label | |
| EventLog | |
| Address | |
| Catalog | |
| CoreTeamList | |
| Segment | |
| CoreTimeSeries | |
| TimeSeries | |
| Command | |
| AutoNumberNumeric | |
| CatalogList | |
| CatalogComboBox | |
| DateRange | |
| DocumentGrid | |
| ReportLink | |
| Hyperlink | |
| PercentComplete | |
| Chart | |
| Range | |
| ExternalId | |
| AssetCatalog | |
| Inventory | |
| CoreTaskLaborItemTypes | |
| CoreTaskLaborItems | |
| ObjectList | |
| CoreTimeZone |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Color | form | string | No | |
| Code | form | string | No | |
| TransitionFrom | form | string | No | |
| TransitionMessage | form | string | No | |
| TransitionCustomFields | form | List<string> | No | |
| HiddenIf | form | string | No | |
| IsStart | form | bool | No | |
| IsEnd | form | bool | No | |
| IsBlocked | form | bool | No | |
| StatusType | form | string | No | |
| ProgressType | form | string | No | |
| AutoCreateDocuments | form | List<string> | No | |
| LockTask | form | bool | No | |
| SubmittedForms | form | List<BindingDescriptor> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Binding | form | string | No | |
| Required | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Title | form | string | No | |
| IsSubDoc | form | bool | No | |
| Folder | form | string | No | |
| IsFragment | form | bool | No | |
| EditTeams | form | List<string> | No | |
| HasSecondaryOwner | form | bool | No | |
| TaskDocument | form | bool | No | |
| AssetDocument | form | bool | No | |
| ContactDocument | form | bool | No | |
| UserDocument | form | bool | No | |
| MultipleCopies | form | bool | No | |
| SubmitOption | form | bool | No | |
| Image | form | string | No | |
| HiddenFor | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Workspace | form | string | No | |
| Type | form | string | No | |
| IsActive | form | bool | No | |
| Name | form | string | No | |
| Make | form | string | No | |
| Model | form | string | No | |
| Manuf | form | string | No | |
| Barcode | form | string | No | |
| Symbol | form | string | No | |
| Color | form | string | No | |
| LineThickness | form | double | No | |
| Scale | form | double | No | |
| VisibilityMin | form | double | No | |
| VisibilityMax | form | double | No | |
| SyncNode | form | bool | No | |
| CustomFields | form | List<CustomField> | No | |
| AllowedParentTypes | form | List<string> | No | |
| AllowedChildTypes | form | List<string> | No | |
| UseLocationHistory | form | bool | No | |
| IsMobileAsset | form | bool | No | |
| Data | form | Dictionary<string, string> | No | |
| GeomType | form | string | No | |
| DocFilter | form | bool | No | |
| ShowRelatedDocs | form | bool | No | |
| AllowedDocTypes | form | List<string> | No | |
| TLA | form | string | No | |
| UseTLAOnMap | form | bool | No | |
| RoutingLocation | form | string | No | |
| Fill | form | string | No | |
| FillOpacity | form | double | No | |
| ShowAnno | form | bool | No | |
| AnnoColor | form | string | No | |
| MaxAnnoVisibility | form | double | No | |
| AnnoFont | form | string | No | |
| HideTypeLabel | form | bool | No | |
| UseAddress | form | bool | No | |
| UseFullScreen | form | bool | No | |
| TimeSeries | form | int | No | |
| IsUnselectable | form | bool | No | |
| EditTeams | form | List<string> | No | |
| IsWarehouse | form | bool | No | |
| IsVehicle | form | bool | No | |
| CustomSymbol | form | Dictionary<string, Object> | No | |
| TaskSeriesTemplates | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | string | No | |
| Name | form | string | No | |
| CustomFields | form | List<CustomField> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Workspace | form | string | No | |
| Type | form | string | No | |
| Icon | form | string | No | |
| SkillTags | form | List<string> | No | |
| MinTimeToComplete | form | double | No | |
| AvgTimeToComplete | form | double | No | |
| MaxTimeToComplete | form | double | No | |
| Template | form | string | No | |
| DocFilter | form | bool | No | |
| ShowRelatedDocs | form | bool | No | |
| AllowedDocTypes | form | List<string> | No | |
| DefaultPriority | form | int? | No | |
| Inactive | form | bool | No | |
| AutoCreateDocuments | form | List<string> | No | |
| PercentCompleteType | form | string | No | |
| UseJobTimers | form | bool | No | |
| InheritAssetTeams | form | bool | No | |
| InheritContactTeams | form | bool | No | |
| EditTeams | form | List<string> | No | |
| UseRequired | form | bool | No | |
| AllowOverride | form | bool | No | |
| RequiredAssets | form | List<RequiredAsset> | No | |
| RequiredInventoryTypes | form | List<RequiredInventoryType> | No | |
| RequiredUsers | form | List<RequiredUser> | No | |
| ActiveLaborTypes | form | Dictionary<string, Object> | No | |
| IndividualUserStatuses | form | bool | No | |
| LockOption | form | bool | No | |
| AutoCreateDocExpressions | form | List<AutoCreateDocExpression> | No | |
| PTO | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Number | form | int | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Number | form | int | No | |
| Type | form | string | No | |
| Name | form | string | No | |
| IsSerialized | form | bool | No | |
| Description | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Number | form | int | No | |
| SkillTags | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Document | form | string | No | |
| Expression | form | string | No | |
| MultipleCopies | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DayOfWeek | form | int | No | |
| Start | form | int | No | |
| End | form | int | No | |
| Lunch | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Category | form | string | No | |
| ObjectId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ObjectId | form | string | No | |
| Name | form | string | No | |
| Inputs | form | List<CustomField> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | form | string | No | |
| Label | form | string | No | |
| Sort | form | string | No | |
| Compare | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Grid | form | List<GridItem> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Binding | form | string | No | |
| Heading | form | string | No | |
| Width | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /{ObjectId}/Workspace HTTP/1.1
Host: dev.fieldsquared.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ObjectId: String,
VersionId: String,
BasedOn: String,
Name: String,
LastUpdated: 0001-01-01,
PaymentRequired: False,
CompanyName: String,
CompanyLogoUri: String,
CompanySupportUrl: String,
CompanySupportEmail: String,
AdminEmail: String,
CompanyAddress:
{
Street: String,
Unit: String,
City: String,
State: String,
Zip: String,
ContactTitle: String,
ContactName: String,
ContactPhone: String,
ContactEmail: String,
Location:
{
y: 0,
x: 0
},
SiteName: String,
GeocodeFailed: False,
Country: String
},
TaskTitle: String,
TasksTitle: String,
TeamTitle: String,
TeamsTitle: String,
UserTitle: String,
UsersTitle: String,
ContactTitle: String,
ContactsTitle: String,
SalesforceElementId: String,
ScheduleTitle: String,
SchedulesTitle: String,
FormTitle: String,
FormsTitle: String,
PoiTitle: String,
PoisTitle: String,
AssetMakeTitle: String,
AssetModelTitle: String,
AssetManufacturerTitle: String,
AssetBarcodeTitle: String,
AssetAncestorsTitle: String,
AssetWarehouseTitle: String,
AssetWarehousesTitle: String,
AssetVehicleTitle: String,
AssetVehiclesTitle: String,
UseTeamMaps: False,
UseContacts: False,
UseAssets: False,
ShouldRunIntegrations: False,
TaskTemplates:
{
String:
{
CustomFields:
[
{
Key: String,
Label: String,
IsActive: False,
IsReadOnly: False,
IsHidden: False,
IsMandatory: False,
DisplayOnMap: False,
CustomFieldDataType: Text,
Values: String,
Prompt: String,
Default: String,
DefaultAutoUpdate: False,
RequiredIf: String,
Hidden:
[
String
],
ReadOnly:
[
String
],
ControlArgs:
{
String: {}
},
IndexSlot: String,
Index: String
}
],
Statuses:
[
{
Name: String,
Color: String,
Code: String,
TransitionFrom: String,
TransitionMessage: String,
TransitionCustomFields:
[
String
],
HiddenIf: String,
IsStart: False,
IsEnd: False,
IsBlocked: False,
StatusType: String,
ProgressType: String,
AutoCreateDocuments:
[
String
],
LockTask: False,
SubmittedForms:
[
{
Binding: String,
Required: False
}
]
}
],
TaskListDetails: String,
AutoAssignStatus: String,
AutoUnassignStatus: String,
AutoScheduleStatus: String,
AutoUnscheduleStatus: String,
AutoUpdateStartStatus: String,
AutoUpdateEndStatus: String,
ArrivalStatus: String,
DepartureStatus: String,
ConfirmArrival: False,
ConfirmDeparture: False,
ManualArrivalAllowed: False,
ManualDepartureAllowed: False,
HideDisabledStatuses: False,
GeofenceRadius: 0
}
},
FormTemplates: String,
DocTemplateGhosts:
{
String:
{
Title: String,
IsSubDoc: False,
Folder: String,
IsFragment: False,
EditTeams:
[
String
],
HasSecondaryOwner: False,
TaskDocument: False,
AssetDocument: False,
ContactDocument: False,
UserDocument: False,
MultipleCopies: False,
SubmitOption: False,
Image: String,
HiddenFor:
[
String
]
}
},
AssetTypes:
{
String:
{
Workspace: String,
Type: String,
IsActive: False,
Name: String,
Make: String,
Model: String,
Manuf: String,
Barcode: String,
Symbol: String,
Color: String,
LineThickness: 0,
Scale: 0,
VisibilityMin: 0,
VisibilityMax: 0,
SyncNode: False,
CustomFields:
[
{
Key: String,
Label: String,
IsActive: False,
IsReadOnly: False,
IsHidden: False,
IsMandatory: False,
DisplayOnMap: False,
CustomFieldDataType: Text,
Values: String,
Prompt: String,
Default: String,
DefaultAutoUpdate: False,
RequiredIf: String,
Hidden:
[
String
],
ReadOnly:
[
String
],
ControlArgs:
{
String: String
},
UseArrayMergeType: Set,
IndexSlot: String,
Index: String
}
],
AllowedParentTypes:
[
String
],
AllowedChildTypes:
[
String
],
UseLocationHistory: False,
IsMobileAsset: False,
Data:
{
String: String
},
GeomType: String,
DocFilter: False,
ShowRelatedDocs: False,
AllowedDocTypes:
[
String
],
TLA: String,
UseTLAOnMap: False,
RoutingLocation: String,
Fill: String,
FillOpacity: 0,
ShowAnno: False,
AnnoColor: String,
MaxAnnoVisibility: 0,
AnnoFont: String,
HideTypeLabel: False,
UseAddress: False,
UseFullScreen: False,
TimeSeries: 0,
IsUnselectable: False,
EditTeams:
[
String
],
IsWarehouse: False,
IsVehicle: False,
CustomSymbol:
{
String: {}
},
TaskSeriesTemplates:
[
String
]
}
},
CatalogTypes:
[
{
Type: String,
Name: String,
CustomFields:
[
{
Key: String,
Label: String,
IsActive: False,
IsReadOnly: False,
IsHidden: False,
IsMandatory: False,
DisplayOnMap: False,
CustomFieldDataType: Text,
Values: String,
Prompt: String,
Default: String,
DefaultAutoUpdate: False,
RequiredIf: String,
Hidden:
[
String
],
ReadOnly:
[
String
],
ControlArgs:
{
String: String
},
UseArrayMergeType: Set,
IndexSlot: String,
Index: String
}
]
}
],
TaskTypes:
[
{
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
}
],
WorkWeek:
[
{
DayOfWeek: 0,
Start: 0,
End: 0,
Lunch: 0
}
],
SalesTaxRate: 0,
SkillTags:
[
String
],
TimeZoneId: String,
IANATimeZoneId: String,
Country: String,
StopTime: 0,
StopDistance: 0,
SpeedingSpeed: 0,
SpeedingDuration: 0,
ContactIcon: String,
UseOnSiteContact: False,
UseServiceAddresses: False,
UseSharedWorkspaces: False,
IsMetric: False,
BreakLength:
[
0
],
PriorityNames:
[
String
],
PriorityDefault: String,
IsFinanceIntegrationEnabled: False,
IsCRMIntegrationEnabled: False,
IsBoxIntegrationEnabled: False,
IsDropboxIntegrationEnabled: False,
IsGoogleDriveIntegrationEnabled: False,
IsEsriIntegrationEnabled: False,
IsPaycomIntegrationEnabled: False,
IsP21IntegrationEnabled: False,
Images:
[
{
Category: String,
ObjectId: String
}
],
ContactCustomFields:
[
{
Key: String,
Label: String,
IsActive: False,
IsReadOnly: False,
IsHidden: False,
IsMandatory: False,
DisplayOnMap: False,
CustomFieldDataType: Text,
Values: String,
Prompt: String,
Default: String,
DefaultAutoUpdate: False,
RequiredIf: String,
Hidden:
[
String
],
ReadOnly:
[
String
],
ControlArgs:
{
String: {}
},
IndexSlot: String,
Index: String
}
],
UserCustomFields:
[
{
Key: String,
Label: String,
IsActive: False,
IsReadOnly: False,
IsHidden: False,
IsMandatory: False,
DisplayOnMap: False,
CustomFieldDataType: Text,
Values: String,
Prompt: String,
Default: String,
DefaultAutoUpdate: False,
RequiredIf: String,
Hidden:
[
String
],
ReadOnly:
[
String
],
ControlArgs:
{
String: {}
},
IndexSlot: String,
Index: String
}
],
TeamCustomFields:
[
{
Key: String,
Label: String,
IsActive: False,
IsReadOnly: False,
IsHidden: False,
IsMandatory: False,
DisplayOnMap: False,
CustomFieldDataType: Text,
Values: String,
Prompt: String,
Default: String,
DefaultAutoUpdate: False,
RequiredIf: String,
Hidden:
[
String
],
ReadOnly:
[
String
],
ControlArgs:
{
String: {}
},
IndexSlot: String,
Index: String
}
],
UseAssetMaintenanceHistory: False,
UseAssetSchedules: False,
UseTaskAssets: False,
UseSchedules: False,
UseTasks: False,
AssetsReadOnly: False,
AssetVisibilityMax: 0,
ContactVisibilityMax: 0,
TaskVisibilityMax: 0,
AutoScanAndTrackAsset: False,
BarcodeTrackAsset: False,
GPSTrackAsset: False,
CustomReports:
[
{
ObjectId: String,
Name: String,
Inputs:
[
{
Key: String,
Label: String,
IsActive: False,
IsReadOnly: False,
IsHidden: False,
IsMandatory: False,
DisplayOnMap: False,
CustomFieldDataType: Text,
Values: String,
Prompt: String,
Default: String,
DefaultAutoUpdate: False,
RequiredIf: String,
Hidden:
[
String
],
ReadOnly:
[
String
],
ControlArgs:
{
String: {}
},
IndexSlot: String,
Index: String
}
]
}
],
ShowRelatedContactDocs: False,
ShowRelatedAssetDocs: False,
RequireAssetName: False,
ShowRelatedTaskDocs: False,
ClientBacklogSort:
[
{
Key: String,
Label: String,
Sort: String,
Compare: String
}
],
AutoAssignJobOnDriving: False,
AutoAssignJobOnSite: False,
AutoAssignJobOnComplete: False,
AutoUnassignJobOnNotStarted: False,
AutoScheduleJobOnDriving: False,
AutoScheduleJobOnComplete: False,
AutoScheduleJobOnSite: False,
AutoUnscheduleJobOnNotStarted: False,
AutoUpdateJobStartTimeOnSite: False,
AutoUpdateJobEndTimeOnComplete: False,
AutoAssignNewTasksTo: String,
UseIntegrationEmail: False,
UseTaskTarget: False,
UseTaskDue: False,
UseTaskPri: False,
UseTaskAddr: False,
TaskListDetails: String,
AutocreateTaskStatusEvents: False,
AutocreateTaskAssignmentEvents: False,
FilterContactsByTeam: False,
FilterUsersAndTeamsByTeam: False,
AutoUpdateTaskContactChanged: False,
AutoAssignTeamsOnTaskCreate: False,
HtmlEmailIncludeTaskName: False,
HtmlEmailIncludeUsers: False,
HtmlEmailIncludeDateCreated: False,
HtmlEmailIncludeDateLastUpdated: False,
ClientStartupView: String,
ClientAutoSyncInterval: 0,
MobileTaskRangePast: 0,
MobileTaskRangeFuture: 0,
ClientShowScheduledTasks: False,
ClientShowMyTasksOnly: False,
ClientShowBacklogTasks: False,
ClientHideCompleteTasks: False,
ClientMapType: String,
ClientGPSAccuracy: String,
ClientShowTaskIconsOnMap: False,
ClientMapLayerScheduledTasks: False,
ClientMapLayerBacklog: False,
ClientMapLayerAssets: False,
ClientMapLayerContacts: False,
ClientMapLayerTracks: False,
ClientMapLayerStops: False,
ClientMapLayerSpeeding: False,
ClientMapStartLocation: String,
SecurityDict:
{
String: 0
},
ContactSearchResultExpression: String,
LandscapePhotos: False,
LogApiTraffic: False,
UseDueDate: False,
UsePriority: False,
ScheduleTimeZones:
[
String
],
UseTimezones: False,
TaskListSummaryExpression1: String,
TaskListSummaryExpression2: String,
ShowScheduleButton: False,
ShowScheduleGrid: False,
ScheduleCustomFields:
[
{
Key: String,
Label: String,
IsActive: False,
IsReadOnly: False,
IsHidden: False,
IsMandatory: False,
DisplayOnMap: False,
CustomFieldDataType: Text,
Values: String,
Prompt: String,
Default: String,
DefaultAutoUpdate: False,
RequiredIf: String,
Hidden:
[
String
],
ReadOnly:
[
String
],
ControlArgs:
{
String: {}
},
IndexSlot: String,
Index: String
}
],
ScheduleGridConfig:
{
Grid:
[
{
Binding: String,
Heading: String,
Width: 0
}
]
},
SaveOnPhoto: False,
CleanseGeocodes: False,
GeocodeQuality: String,
RetainCustomerDatabase: String,
RetainAssetDatabase: String,
ShowDriveTimes: False,
LocAccFilter: 0,
AutoCreateRoutesFromAssignedTasks: False,
TaskNameExpression: String,
UseAddressCountry: False,
MessageAppEnabled: False,
GisLayers:
[
String
],
AllowStatusDoubleClick: False,
UseTimecard: False,
TimecardCategories:
[
String
],
UseLocalAdminUsers: False,
UseInventory: False,
ClientScheduledTaskSort: 0,
LaborPricingHierarchy:
[
String
],
UseLabor: False,
LaborHourFormat: False,
TfaEnabled: False,
TaskNameExpressionAutoUpdate: False,
AutocreateInitialTaskStatusEvent: False,
InactivityTimer: 0,
OfflineAuthTimer: 0,
Sequences:
{
String: 0
},
OverrideEmail: String,
OverrideSms: String,
PortalImageUrl: String,
PortalImageId: String,
SecureImageService: False,
SuppressAssetTeamCascading: False,
MilitaryTime: False,
SecureHookService: False,
ShowDashboard: False,
DefaultBusinessHours: False,
ForceSso:
{
String: False
},
SuppressSsoAccountCreation: False,
UseAdvancedScheduler: False,
EnableUnsavedChangesPrompt: False,
ReturnInactiveWorkspace: False,
CustomerSupportEmail: String,
CustomerSupportPhoneNumber: String,
ShowColorCode: False
}