Field Squared API Services

<back to all web services

TsList

Returns a list of all time series objects based on an input set of owning id's and other input parameters.
Start, End and ModifiedSince properties all use the UTC date time format = YYYY-MM-DDTHH:MM:SSZ

The following routes are available for this service:
POST/{Workspace}/TsList
import 'package:servicestack/servicestack.dart';

/**
* Returns a list of all time series objects based on an input set of owning id's and other input parameters. Start, End and ModifiedSince properties all use the UTC date time format = YYYY-MM-DDTHH:MM:SSZ 
*/
class TsList implements IConvertible
{
    String? Workspace;
    List<String>? Items;
    String? Start;
    String? End;
    String? ModifiedSince;
    String? SeriesType;

    TsList({this.Workspace,this.Items,this.Start,this.End,this.ModifiedSince,this.SeriesType});
    TsList.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Workspace = json['Workspace'];
        Items = JsonConverters.fromJson(json['Items'],'List<String>',context!);
        Start = json['Start'];
        End = json['End'];
        ModifiedSince = json['ModifiedSince'];
        SeriesType = json['SeriesType'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Workspace': Workspace,
        'Items': JsonConverters.toJson(Items,'List<String>',context!),
        'Start': Start,
        'End': End,
        'ModifiedSince': ModifiedSince,
        'SeriesType': SeriesType
    };

    getTypeName() => "TsList";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'dev.fieldsquared.com', types: <String, TypeInfo> {
    'TsList': TypeInfo(TypeOf.Class, create:() => TsList()),
});

Dart TsList DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/TsList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	Items: 
	[
		String
	],
	Start: String,
	End: String,
	ModifiedSince: String,
	SeriesType: String
}