| GET | /{Workspace}/API/Asset/Schema | ||
|---|---|---|---|
| GET, PUT, POST, DELETE | /{Workspace}/API/Asset/{Id} | ||
| GET, PUT, POST, DELETE | /{Workspace}/API/Asset | ||
| GET | /{Workspace}/API/Asset/Schema/{AssetType} |
import 'package:servicestack/servicestack.dart';
class Schedule implements IConvertible
{
String? Workspace;
String? ObjectId;
String? VersionId;
String? BasedOn;
String? Start;
String? End;
String? TimeZone;
List<String>? Users;
List<String>? Teams;
Map<String,dynamic?>? Data;
Schedule({this.Workspace,this.ObjectId,this.VersionId,this.BasedOn,this.Start,this.End,this.TimeZone,this.Users,this.Teams,this.Data});
Schedule.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Workspace = json['Workspace'];
ObjectId = json['ObjectId'];
VersionId = json['VersionId'];
BasedOn = json['BasedOn'];
Start = json['Start'];
End = json['End'];
TimeZone = json['TimeZone'];
Users = JsonConverters.fromJson(json['Users'],'List<String>',context!);
Teams = JsonConverters.fromJson(json['Teams'],'List<String>',context!);
Data = JsonConverters.fromJson(json['Data'],'Map<String,dynamic?>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Workspace': Workspace,
'ObjectId': ObjectId,
'VersionId': VersionId,
'BasedOn': BasedOn,
'Start': Start,
'End': End,
'TimeZone': TimeZone,
'Users': JsonConverters.toJson(Users,'List<String>',context!),
'Teams': JsonConverters.toJson(Teams,'List<String>',context!),
'Data': JsonConverters.toJson(Data,'Map<String,dynamic?>',context!)
};
getTypeName() => "Schedule";
TypeContext? context = _ctx;
}
class DomainItem implements IConvertible
{
String? Workspace;
String? ObjectId;
String? VersionId;
String? LastUpdated;
DomainItem({this.Workspace,this.ObjectId,this.VersionId,this.LastUpdated});
DomainItem.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Workspace = json['Workspace'];
ObjectId = json['ObjectId'];
VersionId = json['VersionId'];
LastUpdated = json['LastUpdated'];
return this;
}
Map<String, dynamic> toJson() => {
'Workspace': Workspace,
'ObjectId': ObjectId,
'VersionId': VersionId,
'LastUpdated': LastUpdated
};
getTypeName() => "DomainItem";
TypeContext? context = _ctx;
}
class Location implements IConvertible
{
double? y;
double? x;
Location({this.y,this.x});
Location.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
y = JsonConverters.toDouble(json['y']);
x = JsonConverters.toDouble(json['x']);
return this;
}
Map<String, dynamic> toJson() => {
'y': y,
'x': x
};
getTypeName() => "Location";
TypeContext? context = _ctx;
}
class Geometry implements IConvertible
{
String? Type;
List<Location>? Coordinates;
Geometry({this.Type,this.Coordinates});
Geometry.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Type = json['Type'];
Coordinates = JsonConverters.fromJson(json['Coordinates'],'List<Location>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Type': Type,
'Coordinates': JsonConverters.toJson(Coordinates,'List<Location>',context!)
};
getTypeName() => "Geometry";
TypeContext? context = _ctx;
}
class MaintenanceRecord implements IConvertible
{
String? DateTime;
String? Notes;
MaintenanceRecord({this.DateTime,this.Notes});
MaintenanceRecord.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
DateTime = json['DateTime'];
Notes = json['Notes'];
return this;
}
Map<String, dynamic> toJson() => {
'DateTime': DateTime,
'Notes': Notes
};
getTypeName() => "MaintenanceRecord";
TypeContext? context = _ctx;
}
class LocationHistory implements IConvertible
{
String? Date;
Location? Location;
String? Barcode;
String? Notes;
bool? IsScan;
LocationHistory({this.Date,this.Location,this.Barcode,this.Notes,this.IsScan});
LocationHistory.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Date = json['Date'];
Location = JsonConverters.fromJson(json['Location'],'Location',context!);
Barcode = json['Barcode'];
Notes = json['Notes'];
IsScan = json['IsScan'];
return this;
}
Map<String, dynamic> toJson() => {
'Date': Date,
'Location': JsonConverters.toJson(Location,'Location',context!),
'Barcode': Barcode,
'Notes': Notes,
'IsScan': IsScan
};
getTypeName() => "LocationHistory";
TypeContext? context = _ctx;
}
class ClassedItem implements IConvertible
{
String? ObjectId;
String? Class;
String? VersionId;
List<String>? Ancestors;
String? Type;
ClassedItem({this.ObjectId,this.Class,this.VersionId,this.Ancestors,this.Type});
ClassedItem.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ObjectId = json['ObjectId'];
Class = json['Class'];
VersionId = json['VersionId'];
Ancestors = JsonConverters.fromJson(json['Ancestors'],'List<String>',context!);
Type = json['Type'];
return this;
}
Map<String, dynamic> toJson() => {
'ObjectId': ObjectId,
'Class': Class,
'VersionId': VersionId,
'Ancestors': JsonConverters.toJson(Ancestors,'List<String>',context!),
'Type': Type
};
getTypeName() => "ClassedItem";
TypeContext? context = _ctx;
}
class EventItem implements IConvertible
{
String? ObjectId;
String? Date;
Location? Location;
String? Barcode;
String? Details;
String? Type;
bool? IsScan;
String? User;
String? SelectedBy;
String? Status;
String? StatusType;
String? DateCreated;
bool? Automatic;
EventItem({this.ObjectId,this.Date,this.Location,this.Barcode,this.Details,this.Type,this.IsScan,this.User,this.SelectedBy,this.Status,this.StatusType,this.DateCreated,this.Automatic});
EventItem.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ObjectId = json['ObjectId'];
Date = json['Date'];
Location = JsonConverters.fromJson(json['Location'],'Location',context!);
Barcode = json['Barcode'];
Details = json['Details'];
Type = json['Type'];
IsScan = json['IsScan'];
User = json['User'];
SelectedBy = json['SelectedBy'];
Status = json['Status'];
StatusType = json['StatusType'];
DateCreated = json['DateCreated'];
Automatic = json['Automatic'];
return this;
}
Map<String, dynamic> toJson() => {
'ObjectId': ObjectId,
'Date': Date,
'Location': JsonConverters.toJson(Location,'Location',context!),
'Barcode': Barcode,
'Details': Details,
'Type': Type,
'IsScan': IsScan,
'User': User,
'SelectedBy': SelectedBy,
'Status': Status,
'StatusType': StatusType,
'DateCreated': DateCreated,
'Automatic': Automatic
};
getTypeName() => "EventItem";
TypeContext? context = _ctx;
}
class Anno implements IConvertible
{
double? X;
double? Y;
double? R;
double? S;
String? T;
Anno({this.X,this.Y,this.R,this.S,this.T});
Anno.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
X = JsonConverters.toDouble(json['X']);
Y = JsonConverters.toDouble(json['Y']);
R = JsonConverters.toDouble(json['R']);
S = JsonConverters.toDouble(json['S']);
T = json['T'];
return this;
}
Map<String, dynamic> toJson() => {
'X': X,
'Y': Y,
'R': R,
'S': S,
'T': T
};
getTypeName() => "Anno";
TypeContext? context = _ctx;
}
class AddressBasic implements IConvertible
{
String? Street;
String? Unit;
String? City;
String? State;
String? Zip;
String? Country;
Location? Location;
AddressBasic({this.Street,this.Unit,this.City,this.State,this.Zip,this.Country,this.Location});
AddressBasic.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Street = json['Street'];
Unit = json['Unit'];
City = json['City'];
State = json['State'];
Zip = json['Zip'];
Country = json['Country'];
Location = JsonConverters.fromJson(json['Location'],'Location',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Street': Street,
'Unit': Unit,
'City': City,
'State': State,
'Zip': Zip,
'Country': Country,
'Location': JsonConverters.toJson(Location,'Location',context!)
};
getTypeName() => "AddressBasic";
TypeContext? context = _ctx;
}
class CustomDataField implements IConvertible
{
String? Binding;
String? Label;
dynamic? Value;
String? DataType;
bool? IsReadOnly;
bool? IsHidden;
String? Values;
CustomDataField({this.Binding,this.Label,this.Value,this.DataType,this.IsReadOnly,this.IsHidden,this.Values});
CustomDataField.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Binding = json['Binding'];
Label = json['Label'];
Value = JsonConverters.fromJson(json['Value'],'dynamic',context!);
DataType = json['DataType'];
IsReadOnly = json['IsReadOnly'];
IsHidden = json['IsHidden'];
Values = json['Values'];
return this;
}
Map<String, dynamic> toJson() => {
'Binding': Binding,
'Label': Label,
'Value': JsonConverters.toJson(Value,'dynamic',context!),
'DataType': DataType,
'IsReadOnly': IsReadOnly,
'IsHidden': IsHidden,
'Values': Values
};
getTypeName() => "CustomDataField";
TypeContext? context = _ctx;
}
/**
* Contains the data for an asset within the system.
*/
class Asset implements IConvertible
{
String? Workspace;
String? TimeZone;
String? AssignedWorkspace;
String? ObjectId;
String? VersionId;
String? BasedOn;
String? ExternalId;
String? Created;
String? LastUpdated;
String? Name;
List<Schedule>? Schedules;
List<DomainItem>? Documents;
List<DomainItem>? Tasks;
List<String>? TaskSeries;
List<String>? TaskSeriesTemplates;
List<DomainItem>? Users;
String? Type;
String? Symbol;
Map<String,String?>? Data;
Geometry? Geometry;
List<MaintenanceRecord>? MaintenanceHistory;
String? Parent;
List<String>? Ancestors;
List<LocationHistory>? LocationHistory;
ClassedItem? Owner;
bool? IsParent;
List<String>? Assets;
List<String>? Contacts;
String? GeometryString;
String? SourceProjection;
List<EventItem>? Events;
Anno? Anno;
List<String>? Teams;
AddressBasic? Address;
String? CreatedBy;
List<String>? InventoryItems;
Map<String,dynamic?>? ActiveLaborTypes;
int? Levels;
int? AllAssests;
String? Barcode;
List<CustomDataField>? CustomDataFields;
Asset({this.Workspace,this.TimeZone,this.AssignedWorkspace,this.ObjectId,this.VersionId,this.BasedOn,this.ExternalId,this.Created,this.LastUpdated,this.Name,this.Schedules,this.Documents,this.Tasks,this.TaskSeries,this.TaskSeriesTemplates,this.Users,this.Type,this.Symbol,this.Data,this.Geometry,this.MaintenanceHistory,this.Parent,this.Ancestors,this.LocationHistory,this.Owner,this.IsParent,this.Assets,this.Contacts,this.GeometryString,this.SourceProjection,this.Events,this.Anno,this.Teams,this.Address,this.CreatedBy,this.InventoryItems,this.ActiveLaborTypes,this.Levels,this.AllAssests,this.Barcode,this.CustomDataFields});
Asset.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Workspace = json['Workspace'];
TimeZone = json['TimeZone'];
AssignedWorkspace = json['AssignedWorkspace'];
ObjectId = json['ObjectId'];
VersionId = json['VersionId'];
BasedOn = json['BasedOn'];
ExternalId = json['ExternalId'];
Created = json['Created'];
LastUpdated = json['LastUpdated'];
Name = json['Name'];
Schedules = JsonConverters.fromJson(json['Schedules'],'List<Schedule>',context!);
Documents = JsonConverters.fromJson(json['Documents'],'List<DomainItem>',context!);
Tasks = JsonConverters.fromJson(json['Tasks'],'List<DomainItem>',context!);
TaskSeries = JsonConverters.fromJson(json['TaskSeries'],'List<String>',context!);
TaskSeriesTemplates = JsonConverters.fromJson(json['TaskSeriesTemplates'],'List<String>',context!);
Users = JsonConverters.fromJson(json['Users'],'List<DomainItem>',context!);
Type = json['Type'];
Symbol = json['Symbol'];
Data = JsonConverters.toStringMap(json['Data']);
Geometry = JsonConverters.fromJson(json['Geometry'],'Geometry',context!);
MaintenanceHistory = JsonConverters.fromJson(json['MaintenanceHistory'],'List<MaintenanceRecord>',context!);
Parent = json['Parent'];
Ancestors = JsonConverters.fromJson(json['Ancestors'],'List<String>',context!);
LocationHistory = JsonConverters.fromJson(json['LocationHistory'],'List<LocationHistory>',context!);
Owner = JsonConverters.fromJson(json['Owner'],'ClassedItem',context!);
IsParent = json['IsParent'];
Assets = JsonConverters.fromJson(json['Assets'],'List<String>',context!);
Contacts = JsonConverters.fromJson(json['Contacts'],'List<String>',context!);
GeometryString = json['GeometryString'];
SourceProjection = json['SourceProjection'];
Events = JsonConverters.fromJson(json['Events'],'List<EventItem>',context!);
Anno = JsonConverters.fromJson(json['Anno'],'Anno',context!);
Teams = JsonConverters.fromJson(json['Teams'],'List<String>',context!);
Address = JsonConverters.fromJson(json['Address'],'AddressBasic',context!);
CreatedBy = json['CreatedBy'];
InventoryItems = JsonConverters.fromJson(json['InventoryItems'],'List<String>',context!);
ActiveLaborTypes = JsonConverters.fromJson(json['ActiveLaborTypes'],'Map<String,dynamic?>',context!);
Levels = json['Levels'];
AllAssests = json['AllAssests'];
Barcode = json['Barcode'];
CustomDataFields = JsonConverters.fromJson(json['CustomDataFields'],'List<CustomDataField>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Workspace': Workspace,
'TimeZone': TimeZone,
'AssignedWorkspace': AssignedWorkspace,
'ObjectId': ObjectId,
'VersionId': VersionId,
'BasedOn': BasedOn,
'ExternalId': ExternalId,
'Created': Created,
'LastUpdated': LastUpdated,
'Name': Name,
'Schedules': JsonConverters.toJson(Schedules,'List<Schedule>',context!),
'Documents': JsonConverters.toJson(Documents,'List<DomainItem>',context!),
'Tasks': JsonConverters.toJson(Tasks,'List<DomainItem>',context!),
'TaskSeries': JsonConverters.toJson(TaskSeries,'List<String>',context!),
'TaskSeriesTemplates': JsonConverters.toJson(TaskSeriesTemplates,'List<String>',context!),
'Users': JsonConverters.toJson(Users,'List<DomainItem>',context!),
'Type': Type,
'Symbol': Symbol,
'Data': Data,
'Geometry': JsonConverters.toJson(Geometry,'Geometry',context!),
'MaintenanceHistory': JsonConverters.toJson(MaintenanceHistory,'List<MaintenanceRecord>',context!),
'Parent': Parent,
'Ancestors': JsonConverters.toJson(Ancestors,'List<String>',context!),
'LocationHistory': JsonConverters.toJson(LocationHistory,'List<LocationHistory>',context!),
'Owner': JsonConverters.toJson(Owner,'ClassedItem',context!),
'IsParent': IsParent,
'Assets': JsonConverters.toJson(Assets,'List<String>',context!),
'Contacts': JsonConverters.toJson(Contacts,'List<String>',context!),
'GeometryString': GeometryString,
'SourceProjection': SourceProjection,
'Events': JsonConverters.toJson(Events,'List<EventItem>',context!),
'Anno': JsonConverters.toJson(Anno,'Anno',context!),
'Teams': JsonConverters.toJson(Teams,'List<String>',context!),
'Address': JsonConverters.toJson(Address,'AddressBasic',context!),
'CreatedBy': CreatedBy,
'InventoryItems': JsonConverters.toJson(InventoryItems,'List<String>',context!),
'ActiveLaborTypes': JsonConverters.toJson(ActiveLaborTypes,'Map<String,dynamic?>',context!),
'Levels': Levels,
'AllAssests': AllAssests,
'Barcode': Barcode,
'CustomDataFields': JsonConverters.toJson(CustomDataFields,'List<CustomDataField>',context!)
};
getTypeName() => "Asset";
TypeContext? context = _ctx;
}
// @DataContract
class PublicAsset implements IConvertible
{
// @DataMember
String? Id;
// @DataMember
String? Workspace;
// @DataMember
String? AssetType;
// @DataMember
Asset? Asset;
// @DataMember
List<Asset>? Assets;
PublicAsset({this.Id,this.Workspace,this.AssetType,this.Asset,this.Assets});
PublicAsset.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
Workspace = json['Workspace'];
AssetType = json['AssetType'];
Asset = JsonConverters.fromJson(json['Asset'],'Asset',context!);
Assets = JsonConverters.fromJson(json['Assets'],'List<Asset>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'Workspace': Workspace,
'AssetType': AssetType,
'Asset': JsonConverters.toJson(Asset,'Asset',context!),
'Assets': JsonConverters.toJson(Assets,'List<Asset>',context!)
};
getTypeName() => "PublicAsset";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'dev.fieldsquared.com', types: <String, TypeInfo> {
'Schedule': TypeInfo(TypeOf.Class, create:() => Schedule()),
'Map<String,dynamic?>': TypeInfo(TypeOf.Class, create:() => Map<String,dynamic?>()),
'DomainItem': TypeInfo(TypeOf.Class, create:() => DomainItem()),
'Location': TypeInfo(TypeOf.Class, create:() => Location()),
'Geometry': TypeInfo(TypeOf.Class, create:() => Geometry()),
'List<Location>': TypeInfo(TypeOf.Class, create:() => <Location>[]),
'MaintenanceRecord': TypeInfo(TypeOf.Class, create:() => MaintenanceRecord()),
'LocationHistory': TypeInfo(TypeOf.Class, create:() => LocationHistory()),
'ClassedItem': TypeInfo(TypeOf.Class, create:() => ClassedItem()),
'EventItem': TypeInfo(TypeOf.Class, create:() => EventItem()),
'Anno': TypeInfo(TypeOf.Class, create:() => Anno()),
'AddressBasic': TypeInfo(TypeOf.Class, create:() => AddressBasic()),
'CustomDataField': TypeInfo(TypeOf.Class, create:() => CustomDataField()),
'Asset': TypeInfo(TypeOf.Class, create:() => Asset()),
'List<Schedule>': TypeInfo(TypeOf.Class, create:() => <Schedule>[]),
'List<DomainItem>': TypeInfo(TypeOf.Class, create:() => <DomainItem>[]),
'List<MaintenanceRecord>': TypeInfo(TypeOf.Class, create:() => <MaintenanceRecord>[]),
'List<LocationHistory>': TypeInfo(TypeOf.Class, create:() => <LocationHistory>[]),
'List<EventItem>': TypeInfo(TypeOf.Class, create:() => <EventItem>[]),
'List<CustomDataField>': TypeInfo(TypeOf.Class, create:() => <CustomDataField>[]),
'PublicAsset': TypeInfo(TypeOf.Class, create:() => PublicAsset()),
'List<Asset>': TypeInfo(TypeOf.Class, create:() => <Asset>[]),
});
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/Asset/{Id} HTTP/1.1
Host: dev.fieldsquared.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Id":"String","Workspace":"String","AssetType":"String","Asset":{"Name":"String","Type":"String","ExternalId":"String","Parent":"String","Lat":0,"Lon":0,"StreetAddress":"String","Unit":"String","City":"String","State":"String","Zip":"String","Country":"String","Data":{"String":{}},"LastUpdated":"String","Created":"String","Tasks":["String"],"Team":"String"},"Assets":[{"Name":"String","Type":"String","ExternalId":"String","Parent":"String","Lat":0,"Lon":0,"StreetAddress":"String","Unit":"String","City":"String","State":"String","Zip":"String","Country":"String","Data":{"String":{}},"LastUpdated":"String","Created":"String","Tasks":["String"],"Team":"String"}]}