| GET, PUT, POST, DELETE | /{Workspace}/API/Catalog/{CatalogType} | ||
|---|---|---|---|
| GET, PUT, POST, DELETE | /{Workspace}/API/Catalog | ||
| GET | /{Workspace}/API/Catalog/Schema/{CatalogType} |
import 'package:servicestack/servicestack.dart';
/**
* Contains the data for a catalog within the system.
*/
class Catalog implements IConvertible
{
String? Workspace;
String? AssignedWorkspace;
String? ObjectId;
String? VersionId;
String? BasedOn;
String? ExternalId;
String? Created;
String? LastUpdated;
String? Name;
String? Type;
String? Parent;
List<String>? Ancestors;
Map<String,Map<String,String>?>? Items;
bool? Enabled;
Catalog({this.Workspace,this.AssignedWorkspace,this.ObjectId,this.VersionId,this.BasedOn,this.ExternalId,this.Created,this.LastUpdated,this.Name,this.Type,this.Parent,this.Ancestors,this.Items,this.Enabled});
Catalog.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Workspace = json['Workspace'];
AssignedWorkspace = json['AssignedWorkspace'];
ObjectId = json['ObjectId'];
VersionId = json['VersionId'];
BasedOn = json['BasedOn'];
ExternalId = json['ExternalId'];
Created = json['Created'];
LastUpdated = json['LastUpdated'];
Name = json['Name'];
Type = json['Type'];
Parent = json['Parent'];
Ancestors = JsonConverters.fromJson(json['Ancestors'],'List<String>',context!);
Items = JsonConverters.fromJson(json['Items'],'Map<String,Map<String,String>?>',context!);
Enabled = json['Enabled'];
return this;
}
Map<String, dynamic> toJson() => {
'Workspace': Workspace,
'AssignedWorkspace': AssignedWorkspace,
'ObjectId': ObjectId,
'VersionId': VersionId,
'BasedOn': BasedOn,
'ExternalId': ExternalId,
'Created': Created,
'LastUpdated': LastUpdated,
'Name': Name,
'Type': Type,
'Parent': Parent,
'Ancestors': JsonConverters.toJson(Ancestors,'List<String>',context!),
'Items': JsonConverters.toJson(Items,'Map<String,Map<String,String>?>',context!),
'Enabled': Enabled
};
getTypeName() => "Catalog";
TypeContext? context = _ctx;
}
// @DataContract
class PublicCatalog implements IConvertible
{
// @DataMember
String? Workspace;
// @DataMember
String? CatalogType;
// @DataMember
Catalog? Catalog;
// @DataMember
List<Catalog>? Catalogs;
PublicCatalog({this.Workspace,this.CatalogType,this.Catalog,this.Catalogs});
PublicCatalog.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Workspace = json['Workspace'];
CatalogType = json['CatalogType'];
Catalog = JsonConverters.fromJson(json['Catalog'],'Catalog',context!);
Catalogs = JsonConverters.fromJson(json['Catalogs'],'List<Catalog>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Workspace': Workspace,
'CatalogType': CatalogType,
'Catalog': JsonConverters.toJson(Catalog,'Catalog',context!),
'Catalogs': JsonConverters.toJson(Catalogs,'List<Catalog>',context!)
};
getTypeName() => "PublicCatalog";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'dev.fieldsquared.com', types: <String, TypeInfo> {
'Catalog': TypeInfo(TypeOf.Class, create:() => Catalog()),
'Map<String,Map<String,String>?>': TypeInfo(TypeOf.Class, create:() => Map<String,Map<String,String>?>()),
'PublicCatalog': TypeInfo(TypeOf.Class, create:() => PublicCatalog()),
'List<Catalog>': TypeInfo(TypeOf.Class, create:() => <Catalog>[]),
});
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 /{Workspace}/API/Catalog/{CatalogType} HTTP/1.1
Host: dev.fieldsquared.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Workspace: String,
CatalogType: String,
Catalog:
{
CatalogType: String,
LastUpdated: String,
Created: String,
Data:
{
String: {}
}
},
Catalogs:
[
{
CatalogType: String,
LastUpdated: String,
Created: String,
Data:
{
String: {}
}
}
]
}