Foundry API

<back to all web services

ReportMachineStatusRequest

Requires Authentication
The following routes are available for this service:
All Verbs/machines/{Id}/statuses
ReportMachineStatusRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
ComponentquerystringNo
ObservedAtqueryDateTimeNo
CodequerystringNo
ErrorCodequerystringNo
ErrorDetailsquerystringNo
PostOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
ReportMachineStatusResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformMachineStatusNo
ResponseStatusformResponseStatusNo
MachineStatus Parameters:
NameParameterData TypeRequiredDescription
ComponentformstringNo
ObservedAtformDateTimeNo
CodeformstringNo
ErrorCodeformstringNo
ErrorDetailsformstringNo
ReportMachineStatusResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformMachineStatusNo
ResponseStatusformResponseStatusNo

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.

POST /machines/{Id}/statuses HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":"String","component":"String","code":"String","errorCode":"String","errorDetails":"String","organisationId":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"status":{"component":"String","code":"String","errorCode":"String","errorDetails":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}