Foundry API

StartJobRequest

The following routes are available for this service:
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()),
});

Dart StartJobRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"machineId":"String","name":"String","totalLayers":0,"organisationId":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"job":{"machineId":"String","name":"String","totalLayers":0,"finishedAt":null,"aborted":false,"id":"String"}}