Foundry API

<back to all web services

AbortActiveJobRequest

Requires Authentication
The following routes are available for this service:
PUT/jobs/active/abort
import 'package:servicestack/servicestack.dart';

abstract class PutPatchOperationUnTenanted<TResponse> implements IPatch, IPut
{
    PutPatchOperationUnTenanted();
    PutPatchOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "PutPatchOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

abstract class PutPatchOperationTenanted<TResponse> extends PutPatchOperationUnTenanted<TResponse> implements ITenantedRequest
{
    String? organisationId;

    PutPatchOperationTenanted({this.organisationId});
    PutPatchOperationTenanted.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() => "PutPatchOperationTenanted<$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 AbortActiveJobResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    Job? job;

    AbortActiveJobResponse({this.responseStatus,this.job});
    AbortActiveJobResponse.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() => "AbortActiveJobResponse";
    TypeContext? context = _ctx;
}

class AbortActiveJobRequest extends PutPatchOperationTenanted<AbortActiveJobResponse> implements IConvertible
{
    String? machineId;

    AbortActiveJobRequest({this.machineId});
    AbortActiveJobRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        machineId = json['machineId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'machineId': machineId
    });

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

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'PutPatchOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'PutPatchOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'Job': TypeInfo(TypeOf.Class, create:() => Job()),
    'AbortActiveJobResponse': TypeInfo(TypeOf.Class, create:() => AbortActiveJobResponse()),
    'AbortActiveJobRequest': TypeInfo(TypeOf.Class, create:() => AbortActiveJobRequest()),
});

Dart AbortActiveJobRequest DTOs

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

HTTP + XML

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

PUT /jobs/active/abort HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AbortActiveJobRequest 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>
</AbortActiveJobRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AbortActiveJobResponse 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>
</AbortActiveJobResponse>