<back to all web services
AssetType
Represents a single asset type
.
The following routes are available for this service:| GET,POST,DELETE | /{Workspace}/AssetType/{Type} | | |
|---|
| GET | /{Workspace}/AssetType | | |
|---|
AssetType Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | path | string | No | |
| Type | path | string | No | |
| IsActive | body | bool | No | |
| Name | body | string | No | |
| Make | body | string | No | |
| Model | body | string | No | |
| Manuf | body | string | No | |
| Barcode | body | string | No | |
| Symbol | body | string | No | |
| Color | body | string | No | |
| LineThickness | body | double | No | |
| Scale | body | double | No | |
| VisibilityMin | body | double | No | |
| VisibilityMax | body | double | No | |
| SyncNode | body | bool | No | |
| CustomFields | body | List<CustomField> | No | |
| AllowedParentTypes | body | List<string> | No | |
| AllowedChildTypes | body | List<string> | No | |
| UseLocationHistory | body | bool | No | |
| IsMobileAsset | body | bool | No | |
| Data | body | Dictionary<string, string> | No | |
| GeomType | body | string | No | |
| DocFilter | body | bool | No | |
| ShowRelatedDocs | body | bool | No | |
| AllowedDocTypes | body | List<string> | No | |
| TLA | body | string | No | |
| UseTLAOnMap | body | bool | No | |
| RoutingLocation | body | string | No | |
| Fill | body | string | No | |
| FillOpacity | body | double | No | |
| ShowAnno | body | bool | No | |
| AnnoColor | body | string | No | |
| MaxAnnoVisibility | body | double | No | |
| AnnoFont | body | string | No | |
| HideTypeLabel | body | bool | No | |
| UseAddress | body | bool | No | |
| UseFullScreen | body | bool | No | |
| TimeSeries | body | int | No | |
| IsUnselectable | body | bool | No | |
| EditTeams | body | List<string> | No | |
| IsWarehouse | body | bool | No | |
| IsVehicle | body | bool | No | |
| CustomSymbol | body | Dictionary<string, Object> | No | |
| TaskSeriesTemplates | body | List<string> | No | |
CustomField Parameters:| 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 | |
CustomFieldDataType Enum:| 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 | |
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}/AssetType/{Type} HTTP/1.1
Host: dev.fieldsquared.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AssetType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Assets">
<AllowedChildTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AllowedChildTypes>
<AllowedDocTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AllowedDocTypes>
<AllowedParentTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AllowedParentTypes>
<AnnoColor>String</AnnoColor>
<AnnoFont>String</AnnoFont>
<Barcode>String</Barcode>
<Color>String</Color>
<CustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.DomainObjects.Model">
<d2p1:CustomField>
<d2p1:ControlArgs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</d2p1:ControlArgs>
<d2p1:CustomFieldDataType>Text</d2p1:CustomFieldDataType>
<d2p1:Default>String</d2p1:Default>
<d2p1:DefaultAutoUpdate>false</d2p1:DefaultAutoUpdate>
<d2p1:DisplayOnMap>false</d2p1:DisplayOnMap>
<d2p1:Hidden xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:Hidden>
<d2p1:Index>String</d2p1:Index>
<d2p1:IndexSlot>String</d2p1:IndexSlot>
<d2p1:IsActive>false</d2p1:IsActive>
<d2p1:IsHidden>false</d2p1:IsHidden>
<d2p1:IsMandatory>false</d2p1:IsMandatory>
<d2p1:IsReadOnly>false</d2p1:IsReadOnly>
<d2p1:Key>String</d2p1:Key>
<d2p1:Label>String</d2p1:Label>
<d2p1:Prompt>String</d2p1:Prompt>
<d2p1:ReadOnly xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:ReadOnly>
<d2p1:RequiredIf>String</d2p1:RequiredIf>
<d2p1:Values>String</d2p1:Values>
</d2p1:CustomField>
</CustomFields>
<CustomSymbol xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
</CustomSymbol>
<Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Data>
<DocFilter>false</DocFilter>
<EditTeams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</EditTeams>
<Fill>String</Fill>
<FillOpacity>0</FillOpacity>
<GeomType>String</GeomType>
<HideTypeLabel>false</HideTypeLabel>
<IsActive>false</IsActive>
<IsMobileAsset>false</IsMobileAsset>
<IsUnselectable>false</IsUnselectable>
<IsVehicle>false</IsVehicle>
<IsWarehouse>false</IsWarehouse>
<LineThickness>0</LineThickness>
<Make>String</Make>
<Manuf>String</Manuf>
<MaxAnnoVisibility>0</MaxAnnoVisibility>
<Model>String</Model>
<Name>String</Name>
<RoutingLocation>String</RoutingLocation>
<Scale>0</Scale>
<ShowAnno>false</ShowAnno>
<ShowRelatedDocs>false</ShowRelatedDocs>
<Symbol>String</Symbol>
<SyncNode>false</SyncNode>
<TLA>String</TLA>
<TaskSeriesTemplates xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TaskSeriesTemplates>
<TimeSeries>0</TimeSeries>
<Type>String</Type>
<UseAddress>false</UseAddress>
<UseFullScreen>false</UseFullScreen>
<UseLocationHistory>false</UseLocationHistory>
<UseTLAOnMap>false</UseTLAOnMap>
<VisibilityMax>0</VisibilityMax>
<VisibilityMin>0</VisibilityMin>
<Workspace>String</Workspace>
</AssetType>