Foundry API

<back to all web services

SearchJobsRequest

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class SearchJobsRequest extends SearchOperationTenanted<SearchJobsResponse>
    {
        public String machineId = null;
        public Boolean completed = null;
        
        public String getMachineId() { return machineId; }
        public SearchJobsRequest setMachineId(String value) { this.machineId = value; return this; }
        public Boolean isCompleted() { return completed; }
        public SearchJobsRequest setCompleted(Boolean value) { this.completed = value; return this; }
    }

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

    public static class SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
    {
        public String distinct = null;
        public Integer limit = null;
        public Integer offset = null;
        public String sort = null;
        public String filter = null;
        
        public String getDistinct() { return distinct; }
        public SearchOperationUnTenanted<TResponse> setDistinct(String value) { this.distinct = value; return this; }
        public Integer getLimit() { return limit; }
        public SearchOperationUnTenanted<TResponse> setLimit(Integer value) { this.limit = value; return this; }
        public Integer getOffset() { return offset; }
        public SearchOperationUnTenanted<TResponse> setOffset(Integer value) { this.offset = value; return this; }
        public String getSort() { return sort; }
        public SearchOperationUnTenanted<TResponse> setSort(String value) { this.sort = value; return this; }
        public String getFilter() { return filter; }
        public SearchOperationUnTenanted<TResponse> setFilter(String value) { this.filter = 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 SearchJobsResponse extends SearchOperationResponse
    {
        public ResponseStatus responseStatus = null;
        public ArrayList<Job> jobs = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public SearchJobsResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public ArrayList<Job> getJobs() { return jobs; }
        public SearchJobsResponse setJobs(ArrayList<Job> value) { this.jobs = value; return this; }
    }

    public static class SearchOperationResponse
    {
        public SearchMetadata metadata = null;
        
        public SearchMetadata getMetadata() { return metadata; }
        public SearchOperationResponse setMetadata(SearchMetadata value) { this.metadata = value; return this; }
    }

    public static class SearchMetadata
    {
        public Integer total = null;
        public Integer limit = null;
        public Integer offset = null;
        public Sorting sort = null;
        public Filtering filter = null;
        
        public Integer getTotal() { return total; }
        public SearchMetadata setTotal(Integer value) { this.total = value; return this; }
        public Integer getLimit() { return limit; }
        public SearchMetadata setLimit(Integer value) { this.limit = value; return this; }
        public Integer getOffset() { return offset; }
        public SearchMetadata setOffset(Integer value) { this.offset = value; return this; }
        public Sorting getSort() { return sort; }
        public SearchMetadata setSort(Sorting value) { this.sort = value; return this; }
        public Filtering getFilter() { return filter; }
        public SearchMetadata setFilter(Filtering value) { this.filter = value; return this; }
    }

    public static class Sorting
    {
        public String by = null;
        public SortDirection direction = null;
        
        public String getBy() { return by; }
        public Sorting setBy(String value) { this.by = value; return this; }
        public SortDirection getDirection() { return direction; }
        public Sorting setDirection(SortDirection value) { this.direction = value; return this; }
    }

    public static enum SortDirection
    {
        Ascending,
        Descending;
    }

    public static class Filtering
    {
        public ArrayList<String> fields = null;
        
        public ArrayList<String> getFields() { return fields; }
        public Filtering setFields(ArrayList<String> value) { this.fields = 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 SearchJobsRequest DTOs

GET /jobs HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	jobs: 
	[
		{
			machineId: String,
			name: String,
			totalLayers: 0,
			finishedAt: ,
			aborted: False,
			id: String
		}
	],
	metadata: 
	{
		total: 0,
		limit: 0,
		offset: 0,
		sort: 
		{
			by: String,
			direction: Ascending
		},
		filter: 
		{
			fields: 
			[
				String
			]
		}
	}
}