Foundry API

<back to all web services

AbortActiveJobRequest

Requires Authentication
The following routes are available for this service:
PUT/jobs/active/abort
namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Job() = 
        member val MachineId:String = null with get,set
        member val Name:String = null with get,set
        member val TotalLayers:Int32 = new Int32() with get,set
        member val StartedAt:DateTime = new DateTime() with get,set
        member val FinishedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Aborted:Boolean = new Boolean() with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type AbortActiveJobResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Job:Job = null with get,set

    [<AllowNullLiteral>]
    type AbortActiveJobRequest() = 
        inherit PutPatchOperationTenanted<AbortActiveJobResponse>()
        member val MachineId:String = null with get,set

    [<AllowNullLiteral>]
    type PutPatchOperationTenanted<'TResponse>() = 
        inherit PutPatchOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type PutPatchOperationUnTenanted<'TResponse>() = 
        interface IPatch
        interface IPut

F# AbortActiveJobRequest 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.

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

{"machineId":"String","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"}}