Foundry API

<back to all web services

GetMachineRequest

Requires Authentication
The following routes are available for this service:
GET/machines/{Id}
GetMachineRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
GetOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
GetOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
EmbedformstringNo
GetMachineResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
MachineformMachineNo
Machine Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
TypeformstringNo
ManufacturedOnformDateOnlyNo
LocationformstringNo
ConfigurationformstringNo
IdformstringNo
GetMachineResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
MachineformMachineNo

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.

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