Foundry API

<back to all web services

AbortActiveJobRequest

Requires Authentication
The following routes are available for this service:
PUT/jobs/active/abort
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Jobs;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;

namespace Application.Interfaces.Resources
{
    public partial class Job
        : IIdentifiableResource
    {
        public virtual string MachineId { get; set; }
        public virtual string Name { get; set; }
        public virtual int TotalLayers { get; set; }
        public virtual DateTime StartedAt { get; set; }
        public virtual DateTime? FinishedAt { get; set; }
        public virtual bool Aborted { get; set; }
        public virtual string Id { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class PutPatchOperationTenanted<TResponse>
        : PutPatchOperationUnTenanted<TResponse>, ITenantedRequest
    {
        public virtual string OrganisationId { get; set; }
    }

    public partial class PutPatchOperationUnTenanted<TResponse>
        : IPatch, IPut
    {
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Jobs
{
    public partial class AbortActiveJobRequest
        : PutPatchOperationTenanted<AbortActiveJobResponse>
    {
        public virtual string MachineId { get; set; }
    }

    public partial class AbortActiveJobResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual Job Job { get; set; }
    }

}

C# AbortActiveJobRequest DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"machineId":"String","organisationId":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}