POST | /jobs |
---|
import 'package:servicestack/servicestack.dart';
abstract class PostOperationUnTenanted<TResponse> implements IPost
{
PostOperationUnTenanted();
PostOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
fromMap(Map<String, dynamic> json) {
return this;
}
Map<String, dynamic> toJson() => {};
getTypeName() => "PostOperationUnTenanted<$TResponse>";
TypeContext? context = _ctx;
}
abstract class PostOperationTenanted<TResponse> extends PostOperationUnTenanted<TResponse> implements ITenantedRequest
{
String? organisationId;
PostOperationTenanted({this.organisationId});
PostOperationTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
organisationId = json['organisationId'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'organisationId': organisationId
});
getTypeName() => "PostOperationTenanted<$TResponse>";
TypeContext? context = _ctx;
}
class Job implements IIdentifiableResource, IConvertible
{
String? machineId;
String? name;
int? totalLayers;
DateTime? startedAt;
DateTime? finishedAt;
bool? aborted;
String? id;
Job({this.machineId,this.name,this.totalLayers,this.startedAt,this.finishedAt,this.aborted,this.id});
Job.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
machineId = json['machineId'];
name = json['name'];
totalLayers = json['totalLayers'];
startedAt = JsonConverters.fromJson(json['startedAt'],'DateTime',context!);
finishedAt = JsonConverters.fromJson(json['finishedAt'],'DateTime',context!);
aborted = json['aborted'];
id = json['id'];
return this;
}
Map<String, dynamic> toJson() => {
'machineId': machineId,
'name': name,
'totalLayers': totalLayers,
'startedAt': JsonConverters.toJson(startedAt,'DateTime',context!),
'finishedAt': JsonConverters.toJson(finishedAt,'DateTime',context!),
'aborted': aborted,
'id': id
};
getTypeName() => "Job";
TypeContext? context = _ctx;
}
class StartJobResponse implements IConvertible
{
ResponseStatus? responseStatus;
Job? job;
StartJobResponse({this.responseStatus,this.job});
StartJobResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
job = JsonConverters.fromJson(json['job'],'Job',context!);
return this;
}
Map<String, dynamic> toJson() => {
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
'job': JsonConverters.toJson(job,'Job',context!)
};
getTypeName() => "StartJobResponse";
TypeContext? context = _ctx;
}
class StartJobRequest extends PostOperationTenanted<StartJobResponse> implements IConvertible
{
String? machineId;
DateTime? startedAt;
String? name;
int? totalLayers;
StartJobRequest({this.machineId,this.startedAt,this.name,this.totalLayers});
StartJobRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
machineId = json['machineId'];
startedAt = JsonConverters.fromJson(json['startedAt'],'DateTime',context!);
name = json['name'];
totalLayers = json['totalLayers'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'machineId': machineId,
'startedAt': JsonConverters.toJson(startedAt,'DateTime',context!),
'name': name,
'totalLayers': totalLayers
});
getTypeName() => "StartJobRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
'PostOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'PostOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'Job': TypeInfo(TypeOf.Class, create:() => Job()),
'StartJobResponse': TypeInfo(TypeOf.Class, create:() => StartJobResponse()),
'StartJobRequest': TypeInfo(TypeOf.Class, create:() => StartJobRequest()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jobs HTTP/1.1
Host: foundrystage-api-app.azurewebsites.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<StartJobRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Jobs">
<OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
<MachineId>String</MachineId>
<Name>String</Name>
<StartedAt>0001-01-01T00:00:00</StartedAt>
<TotalLayers>0</TotalLayers>
</StartJobRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <StartJobResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Jobs"> <Job xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources"> <d2p1:Aborted>false</d2p1:Aborted> <d2p1:FinishedAt>0001-01-01T00:00:00</d2p1:FinishedAt> <d2p1:Id>String</d2p1:Id> <d2p1:MachineId>String</d2p1:MachineId> <d2p1:Name>String</d2p1:Name> <d2p1:StartedAt>0001-01-01T00:00:00</d2p1:StartedAt> <d2p1:TotalLayers>0</d2p1:TotalLayers> </Job> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> </StartJobResponse>