Foundry API

<back to all web services

GetMachineRequest

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

public class dtos
{

    public static class GetMachineRequest extends GetOperationTenanted<GetMachineResponse>
    {
        public String id = null;
        
        public String getId() { return id; }
        public GetMachineRequest 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 GetMachineResponse
    {
        public ResponseStatus responseStatus = null;
        public Machine machine = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetMachineResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Machine getMachine() { return machine; }
        public GetMachineResponse setMachine(Machine value) { this.machine = value; return this; }
    }

    public static class Machine implements IIdentifiableResource
    {
        public String name = null;
        public String type = null;
        public Date manufacturedOn = null;
        public String location = null;
        public String configuration = null;
        public String id = null;
        
        public String getName() { return name; }
        public Machine setName(String value) { this.name = value; return this; }
        public String getType() { return type; }
        public Machine setType(String value) { this.type = value; return this; }
        public Date getManufacturedOn() { return manufacturedOn; }
        public Machine setManufacturedOn(Date value) { this.manufacturedOn = value; return this; }
        public String getLocation() { return location; }
        public Machine setLocation(String value) { this.location = value; return this; }
        public String getConfiguration() { return configuration; }
        public Machine setConfiguration(String value) { this.configuration = value; return this; }
        public String getId() { return id; }
        public Machine setId(String value) { this.id = value; return this; }
    }

}

Java GetMachineRequest 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.

GET /machines/{Id} HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/csv
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"}},"machine":{"name":"String","type":"String","manufacturedOn":"0001-01-01","location":"String","configuration":"String","id":"String"}}