Foundry API

<back to all web services

StartJobRequest

Requires Authentication
The following routes are available for this service:
POST/jobs
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class StartJobRequest extends PostOperationTenanted<StartJobResponse>
    {
        public String machineId = null;
        public Date startedAt = null;
        public String name = null;
        public Integer totalLayers = null;
        
        public String getMachineId() { return machineId; }
        public StartJobRequest setMachineId(String value) { this.machineId = value; return this; }
        public Date getStartedAt() { return startedAt; }
        public StartJobRequest setStartedAt(Date value) { this.startedAt = value; return this; }
        public String getName() { return name; }
        public StartJobRequest setName(String value) { this.name = value; return this; }
        public Integer getTotalLayers() { return totalLayers; }
        public StartJobRequest setTotalLayers(Integer value) { this.totalLayers = value; return this; }
    }

    public static class PostOperationTenanted<TResponse> extends PostOperationUnTenanted<TResponse> implements ITenantedRequest
    {
        public String organisationId = null;
        
        public String getOrganisationId() { return organisationId; }
        public PostOperationTenanted<TResponse> setOrganisationId(String value) { this.organisationId = value; return this; }
    }

    public static class PostOperationUnTenanted<TResponse> implements IPost
    {
        
    }

    public static class StartJobResponse
    {
        public ResponseStatus responseStatus = null;
        public Job job = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public StartJobResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Job getJob() { return job; }
        public StartJobResponse setJob(Job value) { this.job = value; return this; }
    }

    public static class Job implements IIdentifiableResource
    {
        public String machineId = null;
        public String name = null;
        public Integer totalLayers = null;
        public Date startedAt = null;
        public Date finishedAt = null;
        public Boolean aborted = null;
        public String id = null;
        
        public String getMachineId() { return machineId; }
        public Job setMachineId(String value) { this.machineId = value; return this; }
        public String getName() { return name; }
        public Job setName(String value) { this.name = value; return this; }
        public Integer getTotalLayers() { return totalLayers; }
        public Job setTotalLayers(Integer value) { this.totalLayers = value; return this; }
        public Date getStartedAt() { return startedAt; }
        public Job setStartedAt(Date value) { this.startedAt = value; return this; }
        public Date getFinishedAt() { return finishedAt; }
        public Job setFinishedAt(Date value) { this.finishedAt = value; return this; }
        public Boolean isAborted() { return aborted; }
        public Job setAborted(Boolean value) { this.aborted = value; return this; }
        public String getId() { return id; }
        public Job setId(String value) { this.id = value; return this; }
    }

}

Java 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"}}