Foundry API

<back to all web services

GetJobRequest

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

public class dtos
{

    public static class GetJobRequest extends GetOperationTenanted<GetJobResponse>
    {
        public String id = null;
        
        public String getId() { return id; }
        public GetJobRequest setId(String value) { this.id = value; return this; }
    }

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

    public static class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
    {
        public String embed = null;
        
        public String getEmbed() { return embed; }
        public GetOperationUnTenanted<TResponse> setEmbed(String value) { this.embed = value; return this; }
    }

    public static class GetJobResponse
    {
        public ResponseStatus responseStatus = null;
        public Job job = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetJobResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Job getJob() { return job; }
        public GetJobResponse 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 GetJobRequest 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.

GET /jobs/{Id} HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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